ドキュメント

ローカルでのビルド

ドキュメントをローカルでビルドするには:

uv run mkdocs build --clean

ライブリロード付きでドキュメントを配信するには:

uv run mkdocs serve

invoke docs タスクもドキュメントを配信しますが、Docker やリモートアクセスのユースケース向けに 0.0.0.0:8001 にバインドします。

多言語サポート

SIMNOS は多言語ドキュメントに mkdocs-static-i18n プラグインを使用しています。このプラグインはサフィックスベースのアプローチで言語別ファイルを識別します。例えば、日本語でドキュメントを書くには .ja.md サフィックスの付いたファイルを作成すると、プラグインが自動的にサイトの日本語版に使用します。翻訳ファイルが存在しない場合は、デフォルト言語（英語）がフォールバックとして使用されます。