文書情報を設定する

文章を執筆する前に、文書のタイトルや著者などの文書情報を設定しましょう。

前節で作成したGitリポジトリのbook.tomlファイルは以下のようになっています。

[book]
authors = ["gifnksm <makoto.nksm+github@gmail.com>"]
title = "mdbook-ja-templateユーザーズガイド"
language = "ja"
src = "src"
multilingual = false

[output.html]
mathjax-support = true
additional-js = ["js/mermaid.min.js", "js/mermaid-init.js"]
git-repository-url = "https://github.com/gifnksm/mdbook-ja-template"
edit-url-template = "https://github.com/gifnksm/mdbook-ja-template/edit/main/{path}"
site-url = "/mdbook-ja-template/"

[output.linkcheck]

[preprocessor]

[preprocessor.mermaid]
command = "mdbook-mermaid"

以下の設定項目を変更してください。 設定項目の意味についてはmdBookのドキュメントを参照してください。

• bookセクション
  • authors: 著者名を設定する。複数設定する場合はカンマ区切りで記述する
  • title: 文書のタイトルを設定する
• output.htmlセクション
  • git-repository-url: 前節で作成したGitリポジトリのURLを設定する
  • edit-url-template: 前節で作成したGitリポジトリのURLの末尾に/edit/main/{path}を追加したものを設定する
  • site-url: リポジトリ名を設定する

book.tomlはGitHubウェブサイト上で直接編集可能ですが、 Gitリポジトリをcloneして編集することを推奨します。 以降の節ではGitリポジトリをcloneしていることを前提に説明します。