Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.57 KB

DEVELOPERS.md

File metadata and controls

62 lines (43 loc) · 2.57 KB

開発者向け情報 (DEVELOPERS.md)

このドキュメントは、このプロジェクトに貢献するための開発者向けガイドラインです。

目次

リポジトリの目的

このリポジトリは、安野たかひろのマニフェストをGitHub上で管理し、皆さんが自由に議論し、変更提案を行えるようにすることを目的としています。

  • マニフェストがマークダウンで記載されており、誰でもissueやPRを出すことができます。
  • issue機能を使って政策について自由に議論できます。

公式ドキュメント

詳しいドキュメントは mkdocs.org をご覧ください。

プロジェクトレイアウト

このリポジトリは以下のような構造になっています:

mkdocs.yml    # 設定ファイル
docs/
    index.md  # ドキュメントのホームページ
    ...       # その他のマークダウンページ、画像、その他のファイル

ローカルでのビルド方法

ローカル環境でドキュメントをビルドする手順は以下の通りです:

  1. Pythonとpipがインストールされていることを確認してください。
  2. 必要なパッケージをインストールします:
    pip install mkdocs
    pip install mkdocs-material
  3. リポジトリのディレクトリに移動して、以下のコマンドを実行します:
    mkdocs serve
    サーバーが立ち上がり、http://127.0.0.1:8000/ でドキュメントを確認できます。

docsファイルを編集すると、リアルタイムでブラウザに反映されます。表示を確認しながらドキュメントを作成できます。

docs内markdown作成時の注意

MkDocsのバグにより、リストのインデントはスペース4つでないと機能しません。エディタのタブのサイズを4に設定することを推奨します。

デプロイ/Publish