- 自分の GitHub アカウントに
Forkする git cloneを実行し, 自分のローカルにリポジトリをクローンするgit checkout -b <branch-name>を実行し, 新しいブランチを作成する- 編集する
git commit -am "<コミット内容>を実行し, コミットする (コンベンショナルコミットは推奨していませんが, ある程度わかりやすいコミットメッセージでコミットしてください.)git pushGiganticMinecraft/CommandReferenceに対してプルリクエストを送る- レビューを受ける
- マージされる
cmd.seichi.clickにデプロイされる- デプロイは自動で行われます.
マージするには GiganticMinecraft 運営チームメンバーによるレビューが少なくとも1人必要です.
CommandReference は mdbook を使用して制作しているため, ブラウザでのプレビューを確認するには mdbook をインストールする必要があります.
cargo install mdbookRust をインストールしていない場合はバイナリを直接インストールすることもできます.
ただしリファレンスの実体は Markdown のため, 必ずしもブラウザのプレビューを確認する必要はありません. これは Optional です.
mdbook にはプラグイン機能があり, このリポジトリでは以下のプラグインを使用しています.
mdbook-alerts は cargo でインストールできます
cargo install mdbook-alerts mdbook-pagetoc以下のコマンドでローカル上の CommandReference をプレビュー表示できます.
localhost:3000 に公開されますのでブラウザでアクセスしてください.
mdbook serve