Skip to content
MCPlayに属するプロジェクトのドキュメント
HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
custom/partials
docs
.gitignore
README.md
mkdocs.yml

README.md

MCPlayDocs

これはMCPlayに属する全てのプロジェクトドキュメントのリポジトリです。

このリポジトリのドキュメントはここでホストされています。

ブランチ

このリポジトリには下記のブランチがあります。

  • master
  • gh-pages
  • old

masterはドキュメント変更前のステージング領域として利用されます。変更がまとまり次第、公開領域のgh-pagesにデプロイを行います。 2019/08/17以前のデザインのドキュメントはoldにまとめられています。

コントリビューション

MCPlayには管理を行っている小さな有志のチームがいます。しかしチームは管理に集中しているためドキュメントの更新が不十分です。 このドキュメントの高品質で保つのはコントリビューションに依存しています。

もしもドキュメントに問題点やミスを発見した場合、気軽に更新してください。多くの手助けがあることを願っています。

開発

環境

ドキュメントはmkdocs及びmkdocs-materialを使用しています。 これらをインストールすることでリアルタイムに変更をプレビューできます。

  1. Pythonのインストール(Python 2.7, 3.4, 3.5, 3.6, 3.7 および pypyをサポート)
  2. 必要なパッケージをインストールする。

Pythonをインストール後コマンドでmkdocsパッケージをインストール

$ pip install mkdocs mkdocs-material

ビルド

ドキュメントを変更したら、下記のコマンドでビルドすることが可能です。

$ mkdocs build

ビルドが完了するとsiteディレクトリに必要なファイルが生成されます。

  • ドキュメントはGitHub Pagesでホストされるためsiteディレクトリは含めないでください。 *

ローカルでサーバーを起動し確認したい場合、下記のコマンドを実行してください。

$ mkdocs serve

サーバーが実行されるとhttp://127.0.0.1:8000で確認が可能になります。

You can’t perform that action at this time.