Skip to content

マークダウンの書式集

このテキストを記載するために使用しているmarkdownの書式集

注意 期待したように改行されないことがあります、行の右端に 半角スペース を2個入れると治ることがあります

注意 表示されているのはmarkdownをmkdocsで処理してHTML化したものです、処理系で微妙に表示が異なったりサポートされていない場合があります

MkDocsで使えるMarkdownサンプル

見出し表示例

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

見出し入力例

1
2
3
4
5
6
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
種類 入力例 表示例
太字 これは **太字** です。 これは 太字 です。
これは __太字__ です。 これは 太字 です。
斜体 これは *斜体* です。 これは 斜体 です。
これは _斜体_ です。 これは 斜体 です。
訂正線 これは ~~訂正線~~です。 これは ~訂正線~です。
下線 これは<u>下線</u>です。 これは下線です。
引用 > これは引用です。 表示例は表の下
> これは引用です。これは引用です。 表示例は表の下

これは引用です。
これは引用です。これは引用です。

Markdownリンク

別のmarkdownファイルへのリンク

[テキスト](c01_w01.md)

コード

markdownのコードが必要な箇所に直接以下のように記載する

1
2
3
4
5
6
7
```c
#include <stdio.h>

int main() {
    printf("Hello, World!\n");
    return 0;
}
## mermaidの図

markdownの図が必要な箇所に直接以下のように記載する

```markdown
```mermaid
graph LR
    A[CPU]
    B[メモリ]
    C[ストレージ]
    D[入出力装置]
    A --> B
    B --> A
    A --> C
    C --> A
    A --> D
    D --> A

drawioの図

markdownと同じフォルダにdrawioのファイルを配置して、以下のように記載する

![test](./test.drawio)

test

mkdocs処理後だけ使える機能

Note

これはノートです。

Tip

ヒントです。

Warning

これは警告です

Danger

これは危険です。

Success

これは成功です。

Failure

これは失敗です。

Bug

これはバグです。

Summary

これは概要です。

!!! Note
    これはノートです。

!!! Tip
    ヒントです。

!!! Warning
    これは警告です

!!! Danger
    これは危険です。

!!! Success
    これは成功です。

!!! Failure
    これは失敗です。

!!! Bug
    これはバグです。

!!! summary
    これは概要です。

task list

  • aaaaaaa
  • ccccccc
  • XXXXXXX
  • YYYYYYY
  • ZZZZZZZ
1
2
3
4
5
- [x] aaaaaaa
- [ ] ccccccc
  - [x] XXXXXXX
  - [x] YYYYYYY
  - [ ] ZZZZZZZ

alt text