RustのmdBookを試してみた

はじめに

  • Rustでドキュメントを良い感じに作れるツールがあるということで、そちらを試してみた時のことを自分への備忘録として記事にまとめました。

mdBookとは

  • Markdown 形式で簡単にきれいなドキュメントを作成するためのツール
  • Rustのチュートリアル等でよく使われている

環境

  • OS: Windows 10
  • Rust: 1.64.0(インストール済)

mdBookのインストール

  • 以下のコマンドを実行するだけです

    cargo install mdbook

mdBookでドキュメントを作ってみる

  1. 適当な空のディレクトリで以下のコマンドを実行する

    mdbook init

  2. 2つ質問をされるので答える

    • Do you want a .gitignore to be created? (y/n)

      .gitignoreファイルを作るかどうか。yかnで答えましょう

    • What title would you like to give the book?

      作成するbookのタイトルを入力します

  3. これで準備ができました！ディレクトリには以下のように作られます。

     適当なフォルダ
   ├ book
   ├ src
   │ ├ chapter_1.md
   │ └ SUMMARY.md
   ├ .gitignore(作るように指示した場合)
   └ book.toml
  4. 続いて同じディレクトリで以下のコマンドを実行する mdbook build --open
  5. ブラウザが立ち上がり、以下のような画面が出てきたら成功です

おわりに

  • mdBookをインストールしてドキュメントを開くことができました。
  • とても快適に良い感じのドキュメントが作れるのでおススメです。

参考

下記サイトさんで詳しい説明がされてます

blog1.mammb.com