mkdocsを利用した静的サイトジェネレータです。マークダウンファイルの簡単な管理で静的サイトを生成できます。
ドキュメント編集環境を構築するには次のコマンドでドキュメントサーバを起動してください。起動したドキュメントサーバのURLにアクセスするとドキュメントのプレビューを確認できます。
poetry install --only docsmake doc-serve次のコマンドを実行するとsiteディレクトリに成果物が出力されます。
make doc-buildドキュメント生成時のコンフィグファイルです。
静的サイトを生成するためのドキュメントです。
基本的な使い方は公式サイトを参照ください。
アイコンを配置する時、次のリンクからアイコンを検索できます。
Google社が公開しているマテリアルデザインのガイドラインに基づいて作成された公式のアイコンセットです。
Font Awesomeとは、商用利用が可能で、自身のウェブサイトやアプリケーション、WordやPDFなどのドキュメントにも埋め込めるWebアイコンフォントです。
軽量のアイコン集です。基本的なアイコンはそろっている。
https://www.brandcrowd.com/で作成した。
mkdocs-print-site-pluginを使って、すべてのページをまとめた印刷用ページを生成する。ブラウザの印刷からサイト全体を印刷・PDF出力が可能。
mkdocs.ymlのexcludeで任意のページを除外することが可能。
exclude:
- "index.md"PDF印刷などで改ページの都合が悪い場合は、次のコードを任意の行に配置することで改ページを強制できる。
<div style="page-break-before:always" /></div>ページは非表示の方がよさそう。 表紙と目次が不要ならブラウザで印刷ページを指定できる。ちょっと見つけづらい。
こちら をクリックするとGoogle Chrome 拡張機能「uBlacklist」に拒否サイトを追加できます。（いずれここではないどこかに移動）
あと、https://github.com/ncaq/uBlacklistRule も追加しておくといい。