ドキュメントの更新
ドキュメントサイトを更新するには、以下が必要です：
- Markdownを数分で学ぶ
- GitHubアカウントを作成する（ドキュメントサイトのソースコードはGitHubでホストされているため）
ブラウザ
- ページ下部の
Edit pageボタンをクリックします。
- ドキュメントサイトのGitHubページにリダイレクトされます。ここで変更を編集およびプレビューできます。
Note
CONTRIBUTING.mdの.mdはMarkdownファイルを表しますdocs.mdxの.mdxは MarkDown eXtended を表します- これはJavaScriptとJSXコンポーネントのサポートを含むMarkdownのスーパーセットです
- 少し複雑ですが、インタラクティブなコンポーネントを使用できます
- 右上の
Commit changes...ボタンをクリックして、変更をコミットします。以下の点を確認してください：
- 短く説明的な
Commit messageを書く Create a new branch for this commit and start a pull requestチェックボックスにチェックを入れる
Comparing changesページにリダイレクトされます。Create pull requestボタンをクリックして、プルリクエストを作成します。
Create pull requestボタンをクリックして、PRをオープンします。小さな変更の場合は、PRの本文を空のままにしても構いません。
ローカル開発
Note
このセクションでは、git と javascript の知識があることを前提としています。もちろん、進めながら学ぶこともできます。
ドキュメントサイトをローカルで実行するには、以下が必要です：
- deno をインストールして、フォーマットと自動ドキュメント生成を行う
開発サーバーのセットアップ
(Cataclysm-BN) $ deno task docs serve
# または、すでにdocsディレクトリ内にいる場合
(Cataclysm-BN/docs) $ deno task serve
http://localhost:3000 でドキュメントサイトにアクセスできるようになります。ドキュメントに変更を加えると、開発サーバーは自動的にリロードされます。
ページの自動生成
LuaとCLIのドキュメントはソースコードから自動的に生成されます。これらを生成するには、プロジェクトのルートに移動して以下を実行します：
(Cataclysm-BN) $ deno task docs:gen
ライセンス
-
Markdownファイル（
.mdおよび.mdxファイルを含むがこれに限定されない）に貢献することで、ゲームと同じライセンスである CC-BY-SA 3.0 の下で貢献をライセンスすることに同意したことになります。 -
ドキュメントページのソースコード（
.tsファイルを含むがこれに限定されない）に貢献することで、AGPL 3.0 の下で貢献をライセンスすることに同意したことになります。