本書は、静的サイトジェネレータ「MkDocs」を手軽に導入するためのガイドブックです。ドキュメントや個人サイトの作成に広く活用されている静的サイトジェネレータの中で、MkDocsは特にMarkdown形式の柔軟性を活かして効率的なサイト構築を実現します。Markdownをベースにしながら、豊富な拡張機能やプラグインを使うことで、よりリッチな表現が可能になります。
HugoやGatsby、Jekyllと並んでMkDocsも有力な選択肢ですが、国内での情報はまだ少なく、まとまった資料が不足しているのが現状です。そこで、本書は具体的な事例や手順を交え、オープンソースソフトウェア（OSS）のドキュメント作成にMkDocsが多く使われていることを詳しく解説。ドキュメントや簡易ウェブサイトの制作を始めたい方々に、MkDocsがどれほど有効かを知っていただける内容になっています。初心者にもわかりやすく、実践的な情報が詰まった一冊です。
【目次】
第1章 MkDocsとは
第2章 クイックスタート
第3章 構成ファイルmkdocs.ymlの基本設定
第4章 ハンズオン① — readthedocsテーマを使ったドキュメンテーションサイトの作成
第5章 Python-Markdown拡張機能とMkDocsプラグイン
第6章 おすすめPython-Markdown拡張機能・MkDocsプラグイン・テーマの紹介
第7章 ハンズオン② — Material for MkDocsテーマを使ったブログサイトの作成
第8章 GitHub Pagesでサイトを公開する
第9章 Netlifyでサイトを公開する
目次プレビュー
- はじめに
- 第1章 MkDocsとは
- 第2章 クイックスタート
-
対象読者
-
本書の読み方
-
動作確認バージョン
-
表記関係について
-
免責事項
-
底本について
-
1.1 MkDocsの特徴
-
1.2 OSSでの利用例
-
2.1 MkDocs CLIのインストール
-
2.2 mkdocs new —— 新規プロジェクトの作成
-
2.3 mkdocs serve —— サイトのリアルタイムプレビュー
-
2.4 mkdocs build —— 静的ファイルのビルド
-
3.1 プロジェクトに関する設定項目
-
3.2 サイト構成に関する設定項目
-
3.3 サイト生成・プレビューに関する設定項目
-
3.4 追加機能に関する設定項目
-
4.1 プロジェクトの作成
-
4.2 ドキュメントの記述
-
4.3 サイトの生成
-
5.1 Python-Markdown拡張機能
-
5.2 MkDocsプラグイン
-
6.1 Python-Markdown拡張機能
-
6.2 MkDocsプラグイン
-
6.3 MkDocsテーマ
-
7.1 ブログプロジェクトの作成
-
7.2 ブログ記事の追加
-
7.3 プラグインを追加する
-
7.4 サイトの生成
