Skip to content

Instantly share code, notes, and snippets.

@ryotapoi
Last active February 17, 2025 09:15
Show Gist options
  • Save ryotapoi/5fc6ea1207cac6d22a683af0caa1f0b7 to your computer and use it in GitHub Desktop.
Save ryotapoi/5fc6ea1207cac6d22a683af0caa1f0b7 to your computer and use it in GitHub Desktop.
Markdownの書き方を人間+AI向けにまとめた。広く使われているもの、GFMで推奨されているものをベースにしている。リストは `-` で 強調は`*` というのは趣味で、迷わないように一つに限定した。

Markdown 記法ルール

この Markdown 記法ルールに従って、Markdown 文書を作成・修正してください。


1. 見出し

ルール

  • 見出しは # の後に 1 スペースを入れる
  • 見出しの前後には 1 行の空白行を入れる
  • H1 (#) は文書のタイトルのみに使用
  • H2 (##) は主要なセクションの見出しとして使用(強調)
  • H3 (###) 以降は通常のフォントサイズで記述
    • H2 (##) は ** で強調
    • H3 (###) 以降は強調しない
    • H4 (####) 以降の使用は控えめにする

# 文書のタイトル

## **セクションのタイトル**

### 小見出し

2. 段落

ルール

  • ブロック要素(見出し、リスト、引用、コードブロック、表、水平線、段落)の間には 1 行の空白行を入れる(推奨)
  • リスト内の段落を分ける場合は、リスト項目内に空白行を入れる

これは段落1。

これは段落2。  
ここも段落2。半角スペース2つによる改行。

3. 強調(イタリック・太字)

ルール

  • イタリック(斜体)は *テキスト*
  • 太字は **テキスト**
  • イタリック+太字は ***テキスト***
  • * 系列に統一する(_ は使用しない)

*イタリック*  
**太字**  
***イタリック+太字***

4. リスト

ルール

  • リストには - を使用(*+ は使用しない)
  • ネストリストのインデントは 2 スペース
  • リスト項目の後に改行を入れる場合は、行末に半角スペース 2 つ
  • リストの前後には 1 行の空白行を入れる
  • リスト内で段落を分ける場合は、項目内に空白行を入れる(推奨)

- 項目1  
  続きのテキスト(行末に半角スペース 2 つ)

- 項目2

  これは別の段落。

- 項目3
  - サブ項目1
    - サブサブ項目1

5. 引用

ルール

  • 引用の > の後に 1 スペースを入れる
  • 複数行の引用でも各行の先頭に > を付ける
  • 引用の前後には 1 行の空白行を入れる

> これは引用の 1 行目。
> これは引用の 2 行目。

6. コードブロック

ルール

  • フェンス記法(バッククォート 3 つ ```)を使用
  • 言語指定をする(推奨)
  • コードブロックの前後には 1 行の空白行を入れる

    ```swift
    func hello() {
        print("Hello, World!")
    }
    ```

Markdown 内で Markdown を説明するためにコードブロックをインデントしていますが、通常はインデント不要です。


7. インラインコード

ルール

  • バッククォート `` で囲む
  • 記号とテキストの間にスペースは入れない

`print("Hello")` は Python の出力関数です。

8. リンク

ルール

  • [リンクテキスト](URL) の形式を使用
  • URL をそのまま書く場合は <URL> を使用

[GitHub](https://github.com)

<https://github.com>

9. 画像

ルール

  • ![代替テキスト](画像URL "タイトル") の形式を使用
  • 画像の前後には 1 行の空白行を入れる(推奨)

![GitHub ロゴ](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png "GitHub")

10. 表

ルール

  • GitHub Flavored Markdown(GFM)の表記法を使用
  • セルの間は | で区切る
  • ヘッダー行と区切り行の - を適切に揃える
  • 表の前後には 1 行の空白行を入れる

| 名前  | 年齢 | 国籍  |
| :--- | ---: | :---: |
| 太郎  |  25 | 日本  |
| John  |  30 | 🇺🇸   |

11. 水平線

ルール

  • --- を使用
  • 水平線の前後には 1 行の空白行を入れる

---

これは水平線の下のテキスト。

まとめ

Markdown の記法を統一することで、可読性・一貫性・互換性を向上させる。
特に以下のルールを厳守すること:

  • リストは - を使用
  • 強調は * を使用
  • 水平線は --- を使用
  • 改行には <br> を使用せず、行末に半角スペース 2 つを入れる
  • 表のインデントは揃える
  • 各ブロック要素の前後には 1 行の空白行を入れる

このルールを守ることで、どの環境でも統一された表示が可能になる。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment