導入

mdBookは、Markdownで本を作成するコマンドラインツールです。製品やAPIのドキュメント、チュートリアル、教材など、見やすく、移動しやすく、表示をカスタマイズできる形式が必要なものに適しています。

• 軽量なMarkdown構文により、内容の作成に集中できます
• 組み込みの検索機能
• 多くの言語のコードブロックに対応した、色付きの構文ハイライト
• テーマファイルで出力の表示形式をカスタマイズできます
• プリプロセッサーで独自構文への拡張や内容の変更ができます
• バックエンドで複数の形式に出力できます
• 速度、安全性、簡潔さのためにRustで実装
• Rustコード例の自動テスト

このガイド自体が、mdBookで生成できるものの一例です。Rust言語のプロジェクトでもmdBookを使用しており、The Rust Programming Languageという本も、mdBookの優れた使用例です。

貢献

mdBookはフリーでオープンソースです。ソースコードはGitHubで公開されており、不具合や機能の要望はGitHubのIssueトラッカーに投稿できます。バグ修正や機能追加はコミュニティに支えられています。貢献したい場合は、CONTRIBUTINGガイドを読み、プルリクエストの作成を検討してください。

ライセンス

mdBookのソースコードとドキュメントは、Mozilla Public License v2.0で公開されています。