SUMMARY.mdを作る

ウェブサイトでの表示を確認したら、文書の目次となるsrc/SUMMARY.mdを作りましょう。

Gitリポジトリのsrc/ディレクトリ配下のファイルをすべて削除して、src/SUMMARY.mdを作成しましょう。

src/SUMMARY.mdの中身は以下のようになります。作成したい文章の内容に沿った目次を作成しましょう。

# Summary

[はじめに](intro.md)

- [ユーザーズガイド](guide/README.md)
  - [インストール方法](guide/install.md)
  - [使い方](guide/usage.md)
- [リファレンスガイド](reference/README.md)
  - [コマンド一覧](reference/commands.md)
  - [メッセージ一覧](reference/messages.md)

---

- [付録](appendix.md)

src/SUMMARY.mdの構造についてはmdBookのドキュメントを参照してください。通常のMarkdownファイルとは異なり、src/SUMMARY.mdでは一部のMarkdown文法しか使用できません。 src/SUMMARY.mdの内容に問題がある場合は、make serve/make watch/make buildの出力にエラーが表示されます。出力された内容に従ってファイルを修正してください。

Tips

文書執筆を楽にするテクニックを紹介します。

ドラフト

以下のようにURLが空のリンクを記載することで、該当するページがドラフトであることを示すことができます。ドラフトのページは、ウェブサイト上では灰色で表示され、src/配下にファイルは作成されません。

[ページ名]()

空のリンクはMarkdownlintのルールMD042 - No empty linksによって警告されます。警告を無効化するためには、以下をsrc/SUMMARY.mdの先頭に追加してください。

<!-- markdownlint-disable MD042 -->

サンプル

以下に、本ドキュメントのSUMMARY.mdを示します。

# Summary

<!-- markdownlint-disable MD042 -->

[はじめに](./README.md)

- [基本的な使い方](./basic_usage/README.md)
  - [事前準備](./basic_usage/preparation.md)
  - [Gitリポジトリを作成する](./basic_usage/create_git_repository.md)
  - [文書情報を設定する](./basic_usage/set_document_info.md)
  - [ウェブブラウザで表示を確認する](./basic_usage/view_document.md)
  - [SUMMARY.mdを作る](./basic_usage/create_summary.md)
  - [本文を執筆する](./basic_usage/write_document.md)
  - [文書校正する](./basic_usage/correct_document.md)
  - [ウェブサイトとして公開する](./basic_usage/publish_document.md)
  - [ウェブサイト公開後](./basic_usage/after_publish_document.md)
- [応用的な使い方](./advanced_usage/README.md)
  - [mdBookのカスタマイズ](./advanced_usage/customize_mdbook.md)
  - [textlintのカスタマイズ](./advanced_usage/customize_textlint.md)
  - [markdownlintのカスタマイズ](./advanced_usage/customize_markdownlint.md)
  - [Docker Composeの使い方](./advanced_usage/docker_compose.md)
- [リファレンス](./reference/README.md)
  - [makeターゲット一覧](./reference/make_targets.md)

mdbook-ja-templateユーザーズガイド

SUMMARY.mdを作る

Tips

ドラフト

サンプル