プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ | DevelopersIO

直近携わっているプロダクトで「ユーザーガイド」的なドキュメントを作る機会があり、暫く前に幾つか見繕ってみた結果「MkDocs」というツールを選定して環境を作成＆整備して来ました。個人的にこのツールは使い勝手がとても良いと思っており、継続して使って来ていました。 当エントリでは今後の備忘録としてMkDocsの基本的な導入・設定方法と、そのMkDocsで適用させたスタイル「Material for MkDocs」をここまで使ってきた中での個人的Tipsなどをまとめておきたいと思います。 MkDocs Material for MkDocs - Material for MkDocs 目次 MkDocsとは MkDocsのインストール 基本操作 各種設定・定義について サイト名の変更・ベースドキュメントフォルダの指定 テーマに関する設定 タブ形式のメニュー表示 ページの作成・構成・相対パス 本文

[kazu_0]

“MkDocs”[MkDocs]

[peketamin]

よさそう/"MkDocsでは国際化(i18n)対応に関する公式的な仕組みは現状提供されていない模様。惜しい。"

[shinyaa31]

書きました！