ITエンジニア/デザイナ向けにオープンソースを毎日紹介

開発者向けドキュメントは彼らに対してサービスを提供する上でとても重要な存在です。ファイル構成はもちろんのこと、読みやすい文章であったり、リンクの活用など考えるべきポイントがたくさんあります。

今回紹介するmdBookはGitを使った電子書籍作成ソフトウェアGitbookに似せたファイル構成でドキュメントが作れるソフトウェアです。

mdBookの使い方

mdBookで初期化すると、次のような文書構成にになります。後はMarkdownを使ってコンテンツを作っていくだけです。

$ tree .
.
├── book
└── src
    ├── SUMMARY.md
    └── chapter_1.md

2 directories, 2 files

複雑な例では次のようなWebサイトができあがります。左側にメニューが並び、右側にコンテンツが表示されます。

テーマを変更することもできます。

mdBookはGitbookと異なり、ePubファイルが生成できる訳ではありません(将来的にはできるかも知れません)。開発者ドキュメントを提供する場合には検討すべきソフトウェアの一つになるでしょう。

mdBookはRust製のオープンソース・ソフトウェア(Mozilla Public License)です。

rust-lang-nursery/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2