(Markdown)CommonMark Markdown 記法一覧 - tsukimisoba/Blog GitHub Wiki

2025/05/28 記載
CommonMark Markdownは、シンプルで柔軟なマークアップ言語であり、RedmineやGitHubなどの多くのプラットフォームで利用されています。以下に、主要な記法を構造化して説明します。


1. 基本的なテキスト書式

記法 説明 表示例
**太字** 太字 太字
*斜体* 斜体 斜体
***太字+斜体*** 太字+斜体 太字+斜体
~~取消線~~ 取消線 取消線
`コード` インラインコード コード

2. 見出し

Markdownでは、# を使って見出しを作成できます。

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

表示例:

見出し1

見出し2

見出し3


3. 引用

引用は > を使って記述します。

> これは引用です。
>> これは二重引用です。

表示例:

これは引用です。

これは二重引用です。


4. リスト

順不同リスト

* または - を使ってリストを作成できます。

* 項目1
* 項目2
  * サブ項目

表示例:

  • 項目1
  • 項目2
    • サブ項目

番号付きリスト

1. から始めると番号付きリストになります。

1. 項目1
2. 項目2
   1. サブ項目

表示例:

  1. 項目1
  2. 項目2
    1. サブ項目

タスクリスト

チェックボックス付きリストを作成できます(Redmine 5.0以降)。

- [ ] 未完了のタスク
- [x] 完了したタスク

表示例:

  • 未完了のタスク
  • 完了したタスク

5. 水平線

--- を使うと水平線を作成できます。

---

表示例:


6. リンク

[Redmine公式](https://redmine.jp/)

表示例: Redmine公式


7. 画像

![画像の説明](https://example.com/image.png)

表示例: 画像の説明


8. テーブル

| コード | 県名 | 県の鳥 |
|------|------|------|
| 31 | 鳥取県 | オシドリ |
| 32 | 島根県 | ハクチョウ |

表示例:

コード 県名 県の鳥
31 鳥取県 オシドリ
32 島根県 ハクチョウ

9. コードブロック

print("Hello, World!")

表示例:

print("Hello, World!")

10. シンタックスハイライト

特定のプログラミング言語のコードをハイライトできます。

```python
def hello():
    print("Hello, World!")

表示例:
```python
def hello():
    print("Hello, World!")

11. HTMLタグの利用

CommonMark Markdownでは、一部のHTMLタグを使用できます。

<span style="color: red;">赤色のテキスト</span>

表示例: 赤色のテキスト


参考情報

詳細な記法については、RedmineのMarkdown記法ガイドCommonMark公式ドキュメントを参照してください。

この記法を活用すれば、RedmineやGitHubなどで効率的にドキュメントを作成できます。

⚠️ **GitHub.com Fallback** ⚠️