仕様・利用条件は変わることがあります。重要な判断は原典と実際の結果で再確認してください。
この手段について
- 目的
- MkDocsでMarkdown文書を静的HTMLへbuildする
- 構成
- MkDocs + Python
最短の利用経路
- 対応Pythonと小さな文書projectを用意する
- 設定と見出し・linkを持つ文書を作る
- build生成物を開き本文とlinkを確認する
必要条件
- 対応OSまたは許可された利用環境
- 共有してよい入力・保存先と出力形式を確認する
- 公式の利用開始案内でMkDocsの対応環境・導入方法・利用条件を確認し、検証用の環境へ用意します。
向く場面
MkDocsでMarkdown文書を静的HTMLへbuildするという一つの目的を、この利用経路で短く試したい場面。
向かない場面
build成功だけで公開先のURL構成まで保証する用途。
確認方法
previewと静的生成物を区別し、相対linkや画像を照合します。