Markdownチュートリアル

見出し

Markdown見出し構文の詳細解説とベストプラクティス

Markdown見出し構文

見出しはMarkdownドキュメント構造の重要な要素で、ドキュメントの階層構造を作成するために使用されます。Markdownでは2つの方法で見出しを作成できます。

1. 見出し構文

方法1:ハッシュ記号(#)を使用

テキストの前に1つ以上のハッシュ記号(#)を追加して見出しを作成します。ハッシュ記号の数が見出しレベルを表します。

レベル構文レンダリング結果
H1# 見出し1

見出し1

H2## 見出し2

見出し2

H3### 見出し3

見出し3

H4#### 見出し4

見出し4

H5##### 見出し5
見出し5
H6###### 見出し6
見出し6

方法2:アンダーラインを使用(H1とH2のみ)

テキストの下に等号(=)やハイフン(-)を追加して見出しを作成します。あまり使用されません。

構文レンダリング結果
見出し1
=========

見出し1

見出し2
---------

見出し2

2. 構文ルール

基本ルール

  1. ハッシュとテキストの間にスペースが必要

    • ✅ 正しい:# 見出し
    • ❌ 間違い:#見出し
  2. ハッシュの数が見出しレベルを決定

    • 最大6レベルの見出しをサポート
    • 6個を超えるハッシュは通常のテキストとして扱われる
  3. 見出しにはインライン形式を含めることができる

    • 太字:## これは**太字**見出し
    • 斜体:### これは*斜体*見出し
    • インラインコード:#### これは\コード`見出し`

3. ベストプラクティス

ドキュメント構造の推奨事項

  1. 明確な階層構造を使用

    • H1から開始
    • 見出しレベルをスキップしない
    • 論理的な階層を維持
  2. 見出し命名規則

    • 簡潔で明確な見出しを使用
    • 長すぎる見出しを避ける
    • 見出しの一貫性を保つ
  3. 見出しレベルの適切な使用

    • H1:ドキュメントのメインタイトル
    • H2:主要セクション
    • H3:サブセクション
    • H4以下:詳細内容のグループ化

注意事項

  1. 過度なネストを避ける

    • 見出しレベルを多用しない
    • 最大4-5レベルの見出しを推奨
  2. 一貫性を保つ

    • 同一ドキュメント内で同じ見出しスタイルを使用
    • ハッシュ記号方法の統一使用を推奨
  3. 見出しと内容の一致

    • 見出しが下の内容を正確に説明していることを確認
    • 見出しと内容の不一致を避ける
  4. SEOフレンドリー

    • 説明的な見出しを使用
    • キーワードを含めるが、キーワードの詰め込みは避ける

4. よくある質問

Q: 見出しが正しくレンダリングされないのはなぜですか?

A: 以下を確認してください:

  • ハッシュとテキストの間にスペースがありますか?
  • 正しいMarkdown構文を使用していますか?
  • エディターがMarkdownレンダリングをサポートしていますか?

Q: 1行に複数の見出しを使用できますか?

A: 推奨されません。各見出しは1行に配置し、より読みやすくする必要があります。

Q: 見出しに特殊文字を含めることはできますか?

A: はい、ただしHTMLタグなど、レンダリングに影響する可能性のある特殊文字は避けてください。

Q: 番号なしの見出しを作成するにはどうすればよいですか?

A: 見出し構文を直接使用してください。Markdownの見出しはデフォルトで番号がありません。必要に応じて手動で番号を追加してください。


ヒント:見出しはドキュメント構造の基盤です。見出しを適切に使用することで、ドキュメントがより明確で読みやすくなり、目次やナビゲーションの生成にも役立ちます。