GitBookの公開ドキュメントサイトを配信する、オプションでセルフホストも可能なオープンソースのNext.jsレンダリングエンジン。
- スター
- 22,236
- フォーク
- 1,908
- 未解決の Issue
- 659
- 最終コミット
- 18 時間前
これは何?
mdBookはMarkdownファイルのディレクトリを、モダンで閲覧しやすいオンライン書籍に変換します。プログラミングガイドなどのドキュメントや長文コンテンツを想定しており、プロジェクト独自のユーザーガイドもmdBookで作られています。
Rustで書かれており、crates.ioで配布されているため、単一のコマンドラインバイナリとしてインストールできます。書籍の構成は設定ファイルと目次で定義し、出力される静的Webサイトは任意の静的ファイルサーバーでホストできます。
プレーンなMarkdownを使うため、コンテンツをバージョン管理下に置いたまま、任意のテキストエディタで編集できます。ライセンスはMozilla Public License v2.0です。
主な機能
- 01Markdownのソースファイルから静的HTML書籍を生成します。
- 02書籍の構成は目次ファイルで定義します。
- 03crates.io経由で、単一のRust製コマンドラインバイナリとしてインストールできます。
- 04出力は任意の静的ファイルサーバーでホストできる静的Webサイトです。
ユースケース
- プログラミング言語やライブラリのユーザーガイドを公開する。
- Gitリポジトリで管理する社内エンジニアリングドキュメントを作成する。
- 長編チュートリアルや講義ノートを、閲覧しやすいWebサイトとして作成する。
トピック
よくある質問
- mdBook とは?
- MarkdownファイルからGitBookのようなオンライン書籍を作成するRust製CLIツールです。 mdBookはMarkdownファイルのディレクトリを、モダンで閲覧しやすいオンライン書籍に変換します。プログラミングガイドなどのドキュメントや長文コンテンツを想定しており、プロジェクト独自のユーザーガイドもmdBookで作られています。
- mdBook は無料で使えますか?ライセンスは?
- mdBook は MPL-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
- mdBook は今もメンテナンスされていますか?
- 活発にメンテナンス中。mdBook の最終コミットは 2026年10月21日 です。
- mdBook は何に使えますか?
- プログラミング言語やライブラリのユーザーガイドを公開する。 Gitリポジトリで管理する社内エンジニアリングドキュメントを作成する。 長編チュートリアルや講義ノートを、閲覧しやすいWebサイトとして作成する。
- mdBook はどこで入手できますか?
- ソースコードとインストール手順は GitHub にあります:https://github.com/rust-lang/mdBook
概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。
関連プロジェクト
2.9万4039TypeScriptGPL-3.0更新 21 時間前
ビルド不要でMarkdownファイルをWebサイトに変換するドキュメントサイトジェネレーター。
3.2万5784JavaScriptMIT更新 昨日
Markdownファイルから、検索可能でレスポンシブな静的ドキュメントサイトを生成するMkDocs向けMaterial Designテーマ。
2.8万4150PythonMIT更新 5 日前
編集可能なAstroドキュメントサイトをリポジトリに生成し、エージェント向けMarkdownとllms.txtにも対応するscaffolder。
143152TypeScriptMIT更新 3 日前
Hugo向けの、シンプルでモバイル対応の、書籍のようなデザインのドキュメントテーマ。
40971311HTMLMIT更新 21 時間前
VueとViteを基盤に、Markdownからドキュメントサイトやコンテンツサイトを構築する静的サイトジェネレーター。
1.8万2752TypeScriptMIT更新 一昨日