mdBook

Rust製のGitBookみたいなもの。
高速でよさそう。

Documentation

上のサイトがドキュメントを兼ねている。

• CLI
  • インストール方法はこちら
  • サブコマンド:
    • init
    • build
    • serve

CLI & Quickstart

# 新しくブックのディレクトリを作り、初期セットアップを行う
mdbook init <your-book-directory>

# デフォルトでHTMLを ./book にビルド
mdbook build [OPTIONS]

# デフォルトで ./book 以下のHTMLを元にHTTPサーバを起動
mdbook serve [OPTIONS]

NOTE:

• 2020-05-06現在、 serve コマンドはHTML表示のテスト用で、Webサイト用の完全なサーバ機能を目指したものではないとのこと

MEMO

2020-04-29

• config: https://rust-lang.github.io/mdBook/format/config.html
• サイドバーに目次ツリーが表示されているが、 [output.html.fold] で挙動を変えられそう。
  • https://github.com/rust-lang/mdBook/pull/1027
• 目次（Table of Contents）は公式サポートないのかも。イシューになってる
  • {{#toc}}{{/toc}} で行けるんじゃないのかな？
    • https://rust-lang.github.io/mdBook/format/theme/index-hbs.html#1-toc
    • （2020-05-06追記）愚直に書き足したところ、駄目だった
  • https://github.com/rust-lang/mdBook/issues/153
  • 自作している人がいる
    • https://github.com/badboy/mdbook-toc