SUMMARY.md

目次ファイルは、収録する章、その順序と階層、ソースファイルの場所をmdBookへ伝えるために使います。このファイルがなければ、本は作れません。

このMarkdownファイルの名前は、SUMMARY.mdでなければなりません。解析しやすくするため、厳格な書式が定められており、以下の構成に従う必要があります。以下に指定されていない要素は、書式でも文字列でも、よくても無視され、場合によっては本のビルド時にエラーになる可能性があります。

構成

  1. タイトル — 省略できますが、通常は# Summaryなどのタイトルで始めます。ただし、解析時には無視されるので、なくても構いません。

    # Summary
    
  2. 前付けの章 — 主な番号付きの章の前に、番号なしの章を追加できます。序文や導入などに便利です。ただし、前付けの章は入れ子にできず、すべてルート階層に置く必要があります。また、番号付きの章を追加した後には、前付けの章を追加できません。

    [A Prefix Chapter](relative/path/to/markdown.md)
    
    - [First Chapter](relative/path/to/markdown2.md)
    
  3. 部のタイトル — レベル1の見出しは、以降の番号付きの章をまとめるタイトルとして使えます。本の各部分を論理的に分けるためのものです。クリックできない文字列として表示されます。タイトルは省略でき、番号付きの章は任意の数の部に分けられます。部のタイトルにはh1見出し(#ひとつ)を使う必要があり、ほかのレベルの見出しは無視されます。

    # My Part Title
    
    - [First Chapter](relative/path/to/markdown.md)
    
  4. 番号付きの章 — 本の主要な内容を構成します。入れ子にして、章や下位の章などの階層を作れます。

    # Title of Part
    
    - [First Chapter](relative/path/to/markdown.md)
    - [Second Chapter](relative/path/to/markdown2.md)
       - [Sub Chapter](relative/path/to/markdown3.md)
    
    # Title of Another Part
    
    - [Another Chapter](relative/path/to/markdown4.md)
    

    番号付きの章は、-または*で表せます(区切り記号を混在させないでください)。

  5. 後付けの章 — 前付けの章と同様に番号は付きませんが、番号付きの章の後に置きます。

    - [Last Chapter](relative/path/to/markdown.md)
    
    [Title of Suffix Chapter](relative/path/to/markdown2.md)
    
  6. 草稿の章 — ファイルがなく、内容もない章です。これから書く章を示す目的で使います。また、本の構成を頻繁に変更している設計段階で、ファイルの作成を避けるためにも使えます。HTMLレンダラーでは、草稿の章は目次の無効なリンクとして表示されます。左側の目次にある次の章がその例です。通常の章と同じように記述し、ファイルへのパスだけを書きません。

    - [Draft Chapter]()
    
  7. 区切り線 — ほかの要素の前、間、後に追加できます。ビルドした目次にHTMLの横線として表示されます。区切り線は、3つ以上のハイフンだけを含む行(---)です。

    # My Part Title
    
    [A Prefix Chapter](relative/path/to/markdown.md)
    
    ---
    
    - [First Chapter](relative/path/to/markdown2.md)
    

例

以下は、このガイドのSUMMARY.mdのMarkdownソースです。生成される目次は左側に表示されています。

# Summary

[Introduction](README.md)

# User guide

- [Installation](guide/installation.md)
- [Reading books](guide/reading.md)
- [Creating a book](guide/creating.md)

# Reference guide

- [Command-line tool](cli/README.md)
    - [init](cli/init.md)
    - [build](cli/build.md)
    - [watch](cli/watch.md)
    - [serve](cli/serve.md)
    - [test](cli/test.md)
    - [clean](cli/clean.md)
    - [completions](cli/completions.md)
- [Format](format/README.md)
    - [SUMMARY.md](format/summary.md)
        - [Draft chapter]()
    - [Configuration](format/configuration/README.md)
        - [General](format/configuration/general.md)
        - [Preprocessors](format/configuration/preprocessors.md)
        - [Renderers](format/configuration/renderers.md)
        - [Environment variables](format/configuration/environment-variables.md)
    - [Theme](format/theme/README.md)
        - [index.hbs](format/theme/index-hbs.md)
        - [Syntax highlighting](format/theme/syntax-highlighting.md)
        - [Editor](format/theme/editor.md)
    - [MathJax support](format/mathjax.md)
    - [mdBook-specific features](format/mdbook.md)
    - [Markdown](format/markdown.md)
- [Continuous integration](continuous-integration.md)
- [For developers](for_developers/README.md)
    - [Preprocessors](for_developers/preprocessors.md)
    - [Alternative backends](for_developers/backends.md)

-----------

[Contributors](misc/contributors.md)