このドキュメントは、このプロジェクトに貢献するための開発者向けガイドラインです。
このリポジトリは、安野たかひろのマニフェストをGitHub上で管理し、皆さんが自由に議論し、変更提案を行えるようにすることを目的としています。
- マニフェストがマークダウンで記載されており、誰でもissueやPRを出すことができます。
- issue機能を使って政策について自由に議論できます。
詳しいドキュメントは mkdocs.org をご覧ください。
このリポジトリは以下のような構造になっています:
mkdocs.yml # 設定ファイル
docs/
index.md # ドキュメントのホームページ
... # その他のマークダウンページ、画像、その他のファイル
ローカル環境でドキュメントをビルドする手順は以下の通りです:
- Pythonとpipがインストールされていることを確認してください。
- 必要なパッケージをインストールします:
pip install mkdocs pip install mkdocs-material
- リポジトリのディレクトリに移動して、以下のコマンドを実行します:
サーバーが立ち上がり、http://127.0.0.1:8000/ でドキュメントを確認できます。
mkdocs serve
docsファイルを編集すると、リアルタイムでブラウザに反映されます。表示を確認しながらドキュメントを作成できます。
MkDocsのバグにより、リストのインデントはスペース4つでないと機能しません。エディタのタブのサイズを4に設定することを推奨します。