From dec8dad3efa27071f2ebe1e21edbf79f95a22bc9 Mon Sep 17 00:00:00 2001 From: Builder <92662457+Builder256@users.noreply.github.com> Date: Mon, 9 Feb 2026 02:03:07 +0900 Subject: [PATCH 1/3] =?UTF-8?q?Add:=20=E7=B7=A8=E9=9B=86=E6=96=B9=E6=B3=95?= =?UTF-8?q?=E3=81=AB=E3=81=A4=E3=81=84=E3=81=A6=E3=81=AE=E3=83=9A=E3=83=BC?= =?UTF-8?q?=E3=82=B8=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/edit/index.md | 110 +++++++++++++++++++++++++++++++++++++ mkdocs.yml | 3 + 2 files changed, 113 insertions(+) create mode 100644 docs/content/edit/index.md diff --git a/docs/content/edit/index.md b/docs/content/edit/index.md new file mode 100644 index 0000000..89a2f5d --- /dev/null +++ b/docs/content/edit/index.md @@ -0,0 +1,110 @@ +# Forge Modding Notes の編集方法 + +## 概要 +Forge Modding Notes は、知見の共有を目的としており、内容の更新、誤字脱字の修正、新しいページの追加など、あらゆるコントリビュートを歓迎します。 + +この Wiki は [MkDocs](https://www.mkdocs.org/) と [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) を使用して構築されており、GitHub 上で管理されています。 + +??? info "Git や Python をインストールしていない場合" + Git や Python などのローカル環境がない場合でも、**GitHub のウェブエディタ**を使用して、ブラウザ上だけで手軽に編集やプルリクエストの送信が可能です。 + + 1. 編集したいページの右上にある **「Edit this page」** アイコン（鉛筆マーク）をクリックします。 + 2. ブラウザ上で直接内容を編集します。 + 3. 「Preview」タブで、Markdown の簡易的なレンダリング結果を確認できます。 + * ※アドモニションなどの MkDocs 固有の機能は正しく表示されない場合があります。 + 4. 編集が終わったら、ページ下部の 「Commit changes...」 から変更内容を送信します。 + 5. 自動的にフォークとプルリクエストの作成画面へ進みます。 + +??? tip "ブラウザ上で完全なプレビュー環境を利用したい場合" + GitHub の **Codespaces** を利用すると、ブラウザ上で VS Code が起動し、Python などの環境構築を自分で行うことなく、本番同様のプレビュー（`mkdocs serve`）を実行できます。 + リポジトリのトップにある、緑色の「Code」ボタンから「Codespaces」タブを選択して作成してください。 + +--- + +## 編集の手順（ローカル環境） + +### 1. リポジトリの準備 + +1. GitHub の [toapuro/modding-notes](https://github.com/toapuro/modding-notes) をフォークします。 +2. フォークしたリポジトリをローカルにクローンします。 + ```bash title="Terminal" + git clone https://github.com/YOUR_USERNAME/modding-notes.git + cd modding-notes + ``` + +### 2. ローカル環境の構築 + +プレビューを確認するために、Python をインストールしている必要があります。 + +1. 必要なパッケージをインストールします。 + ```bash title="Terminal" + pip install -r requirements.txt + ``` + +### 3. 内容の編集 + +1. **Markdown ファイルの作成・編集**: + - ドキュメントの本体は `docs/content/` ディレクトリ内にあります。 + - 既存のページを更新するか、新しい `.md` ファイルを作成してください。 +2. **ナビゲーションの更新**: + - 新しいページを追加した場合は、ルートディレクトリにある `mkdocs.yml` の `nav` セクションに、ナビゲーションに表示されるラベルと、それに対応するファイルパスを追記してください。 + +### 4. ローカルでのプレビュー + +編集した内容をブラウザで確認します。 + +```bash title="Terminal" +mkdocs serve +``` + +実行後、 `http://127.0.0.1:8000/modding-notes/content/` にアクセスすると、リアルタイムでプレビューが表示されます。 + +??? bug "リアルタイムプレビューが動作しない場合" + 2026年2月現在、[リアルタイムプレビューが動作しない不具合が報告](https://github.com/squidfunk/mkdocs-material/issues/8478)されています。 + + この場合には、`--livereload`オプションを明示的に指定して実行することで、リアルタイムプレビューが動作する可能性があります。 + + ```bash title="Terminal" + mkdocs serve --livereload + ``` + +### 5. コミットとプッシュ + +変更が完了したら、コミットしてプッシュします。 + +**コミットメッセージの形式:** +[`CONTRIBUTING.md`](https://github.com/toapuro/modding-notes/blob/master/CONTRIBUTING.md) に基づき、以下の形式を使用してください。 + +- `Add: <内容>` : ドキュメントの新規追加 +- `Update: <内容>` : ドキュメントの更新 +- `Fix: <内容>` : 誤字脱字やバグの修正 + +```bash title="Terminal" +git add . +git commit -m "Update: 編集方法のページを追加" +git push origin main +``` + +### 6. プルリクエストの作成 + +GitHub 上でオリジナルのリポジトリに対してプルリクエスト（PR）を作成してください。 +未完成の状態でも、「Draft PR」として送っていただければサポートできる場合があります。 + +--- + +## 執筆のガイドライン + +### 推奨されるスタイル + +- **正確性より共有**: 完璧な文章である必要はありません。有用な知見を残すことを優先してください。 +- **コードブロック**: 言語名を指定して(例: ` ```java ` )記述してください。可能であれば `title="Filename.java"` のようにタイトルを付けてください。 +- **アドモニション（注釈など）**: Material for MkDocs の機能が使用可能です。 + ```markdown + !!! info "タイトル" + ここに内容を記述します。 + ``` + +### 禁止事項 + +- 他者の著作権を侵害する内容の転載。 +- Minecraft の EULA に違反する内容。 diff --git a/mkdocs.yml b/mkdocs.yml index 24d7437..ac4493a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -119,3 +119,6 @@ nav: - インジェクション: content/mixin/injections.md - MixinExtras: content/mixin/mixin-extras.md - トリック: content/mixin/tricks.md + + - 編集: + - 編集方法: content/edit/index.md From 66499809b9becb78a79102cabda9b013df5274b4 Mon Sep 17 00:00:00 2001 From: Builder <92662457+Builder256@users.noreply.github.com> Date: Mon, 9 Feb 2026 20:37:26 +0900 Subject: [PATCH 2/3] =?UTF-8?q?Update:=20=E7=B7=A8=E9=9B=86=E6=96=B9?= =?UTF-8?q?=E6=B3=95=E3=81=AE=E5=86=85=E5=AE=B9=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/edit/index.md | 117 +++++++++++++++++++++++++++++-------- 1 file changed, 93 insertions(+), 24 deletions(-) diff --git a/docs/content/edit/index.md b/docs/content/edit/index.md index 89a2f5d..9ae955b 100644 --- a/docs/content/edit/index.md +++ b/docs/content/edit/index.md @@ -1,38 +1,39 @@ # Forge Modding Notes の編集方法 ## 概要 -Forge Modding Notes は、知見の共有を目的としており、内容の更新、誤字脱字の修正、新しいページの追加など、あらゆるコントリビュートを歓迎します。 +Forge Modding Notes は、内容の更新、誤字脱字の修正、新しいページの追加など、あらゆる形態のコントリビュートを歓迎します。 この Wiki は [MkDocs](https://www.mkdocs.org/) と [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) を使用して構築されており、GitHub 上で管理されています。 ??? info "Git や Python をインストールしていない場合" - Git や Python などのローカル環境がない場合でも、**GitHub のウェブエディタ**を使用して、ブラウザ上だけで手軽に編集やプルリクエストの送信が可能です。 + MkDocs は Python で動作するため、実際のサイトでの表示上で確認するにはローカル環境に Python をインストールする必要がありますが、GitHub のウェブエディタを使用することで、ブラウザ上でも編集やプルリクエストの作成が可能です。 - 1. 編集したいページの右上にある **「Edit this page」** アイコン（鉛筆マーク）をクリックします。 - 2. ブラウザ上で直接内容を編集します。 - 3. 「Preview」タブで、Markdown の簡易的なレンダリング結果を確認できます。 - * ※アドモニションなどの MkDocs 固有の機能は正しく表示されない場合があります。 - 4. 編集が終わったら、ページ下部の 「Commit changes...」 から変更内容を送信します。 - 5. 自動的にフォークとプルリクエストの作成画面へ進みます。 + 1. 編集したいページの右上にある、鉛筆のアイコンをクリックします。 + 2. 編集画面が開くので、初回のみ、緑色の「Fork this repository」ボタンをクリックし、自身のGitHubに**リポジトリをフォーク**します。 + 3. 編集画面がエディタに切り替わり、編集を行えるようになります。 + この際、「Preview」タブで、Markdown の簡易的なレンダリング結果を確認できます。 + アドモニションなどの MkDocs や Material for MkDocs に固有の機能は正しく表示されない場合があります。 + 4. 編集が終わったら、緑色の 「Commit changes…」 から以下のローカルでの場合と同様に**コミットを作成**します。 + 5. コミットの作成が完了すると、そのまま**プルリクエストの作成**画面へ進みます。 ??? tip "ブラウザ上で完全なプレビュー環境を利用したい場合" - GitHub の **Codespaces** を利用すると、ブラウザ上で VS Code が起動し、Python などの環境構築を自分で行うことなく、本番同様のプレビュー（`mkdocs serve`）を実行できます。 + GitHub の **Codespaces** を利用すると、ブラウザ上で VSCode と同様のエディタが起動し、Python などの環境構築を自分で行うことなく、本番同様のプレビュー（`mkdocs serve`）を実行できます。 リポジトリのトップにある、緑色の「Code」ボタンから「Codespaces」タブを選択して作成してください。 --- -## 編集の手順（ローカル環境） +## 編集の手順 ### 1. リポジトリの準備 1. GitHub の [toapuro/modding-notes](https://github.com/toapuro/modding-notes) をフォークします。 2. フォークしたリポジトリをローカルにクローンします。 ```bash title="Terminal" - git clone https://github.com/YOUR_USERNAME/modding-notes.git + git clone https://github.com//modding-notes.git cd modding-notes ``` -### 2. ローカル環境の構築 +### 2. 編集環境の構築 プレビューを確認するために、Python をインストールしている必要があります。 @@ -59,7 +60,7 @@ mkdocs serve 実行後、 `http://127.0.0.1:8000/modding-notes/content/` にアクセスすると、リアルタイムでプレビューが表示されます。 -??? bug "リアルタイムプレビューが動作しない場合" +??? info "リアルタイムプレビューが動作しない場合" 2026年2月現在、[リアルタイムプレビューが動作しない不具合が報告](https://github.com/squidfunk/mkdocs-material/issues/8478)されています。 この場合には、`--livereload`オプションを明示的に指定して実行することで、リアルタイムプレビューが動作する可能性があります。 @@ -92,19 +93,87 @@ GitHub 上でオリジナルのリポジトリに対してプルリクエスト --- -## 執筆のガイドライン +## 文法 -### 推奨されるスタイル +原稿は、[Markdown](https://daringfireball.net/projects/markdown/)で記述してください。 -- **正確性より共有**: 完璧な文章である必要はありません。有用な知見を残すことを優先してください。 -- **コードブロック**: 言語名を指定して(例: ` ```java ` )記述してください。可能であれば `title="Filename.java"` のようにタイトルを付けてください。 -- **アドモニション（注釈など）**: Material for MkDocs の機能が使用可能です。 - ```markdown - !!! info "タイトル" - ここに内容を記述します。 - ``` +基本的には一般的なMarkdownを使用しますが、以下に示すようないくつかの拡張記法が使用可能です。 -### 禁止事項 +### コードブロック -- 他者の著作権を侵害する内容の転載。 +以下のように、使用するコンピュータ言語やファイル名を指定することで、シンタックスハイライトの表示や対応ファイルなどの情報を明示できます。 + +**使用例** + +````markdown title="codeblock-example.md" +```java title="Main.java" +public class Main { + public static void main(String[] args) { + System.out.println("Hello World!"); + } + } +``` +```` + +**結果** + +```java title="Main.java" +public class Main { + public static void main(String[] args) { + System.out.println("Hello World!"); + } + } +``` + +詳細な説明は、 [Code blocks - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) を参照してください。 + +### アドモニション + +**使用例** + +```markdown +!!! info "カスタムのタイトル" + ここに内容を記述します。 +``` + +**結果** + +!!! info "カスタムのタイトル" + ここに内容を記述します。 + +詳細な説明は、 [Admonitions - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) を参照してください。 + +### タブ + +**使用例** + +```markdown +=== "タブ1" + タブ1の内容 + +=== "タブ2" + タブ2の内容 +``` + +**結果** + +=== "タブ1" + タブ1の内容 + +=== "タブ2" + タブ2の内容 + +詳細な説明は、 [Content tabs - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/) を参照してください。 + +--- + +## スタイルガイド + +!!! warning "要検討" + +## 禁止事項 + +原稿には、以下の内容を含むことはできません。注意してください + +- 他者の著作権を侵害する内容。 - Minecraft の EULA に違反する内容。 From eea81056b1634a220d615139bd2d4e94daa8db57 Mon Sep 17 00:00:00 2001 From: Builder <92662457+Builder256@users.noreply.github.com> Date: Mon, 9 Feb 2026 21:22:16 +0900 Subject: [PATCH 3/3] =?UTF-8?q?Update:=20CONTRIBUTE.md=E3=81=AE=E5=86=85?= =?UTF-8?q?=E5=AE=B9=E3=82=92=E3=83=9A=E3=83=BC=E3=82=B8=E5=86=85=E3=81=AB?= =?UTF-8?q?=E7=A7=BB=E5=8B=95=E3=80=81=E3=81=84=E3=81=8F=E3=81=A4=E3=81=8B?= =?UTF-8?q?=E3=81=AE=E3=83=9F=E3=82=B9=E3=82=92=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 29 ++--------------------------- docs/content/edit/index.md | 26 ++++++++++++++++---------- 2 files changed, 18 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1708db3..5d8a86e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,5 @@ # Contributing -## Wikiについて -このWikiは、完全性や正確性よりも**共有できる知見**を残すことを目的としています。 - -## コントリビュートについて - -未完成の状態でも、ドラフトPRとして送ってくれるとサポートができるかもしれません。 - -また、誤りがあった場合でも、レビュー時に確認するので大丈夫です。 - -## フォーマット - -### コミット - -コミットメッセージは以下の形式です。 -`: ` - -`type` は以下のいずれかです。 -- `Add`: ドキュメントの追加 -- `Update`: ドキュメントの更新 -- `Fix`: ドキュメントの修正 -- `Ci`: Github CIの設定の変更 - -## 編集方法 - -1. `docs/` の中にMarkdownファイルを作成 -2. `mkdocs.yml` の `nav` に追記 -3. `mkdocs serve` を実行して、ローカルで確認 +このプロジェクトへの貢献（編集や修正）に関するガイドラインは、サイト内の「[編集方法](https://toapuro.github.io/modding-notes/content/edit/)」ページに記載されています。 +詳細な手順やコミットメッセージのフォーマット、原稿で使用する文法等については、上記リンク先を参照してください。 diff --git a/docs/content/edit/index.md b/docs/content/edit/index.md index 9ae955b..1decd82 100644 --- a/docs/content/edit/index.md +++ b/docs/content/edit/index.md @@ -3,6 +3,11 @@ ## 概要 Forge Modding Notes は、内容の更新、誤字脱字の修正、新しいページの追加など、あらゆる形態のコントリビュートを歓迎します。 +このWikiでは、完全性や正確性よりも**共有できる知見**を残すことを目的としています。 +そのため、未完成の状態でも、Draft PR として送っていただければサポートができるかもしれません。 + +また、誤りがあった場合でも、レビュー時に確認を行うので問題ありません。 + この Wiki は [MkDocs](https://www.mkdocs.org/) と [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) を使用して構築されており、GitHub 上で管理されています。 ??? info "Git や Python をインストールしていない場合" @@ -74,15 +79,16 @@ mkdocs serve 変更が完了したら、コミットしてプッシュします。 **コミットメッセージの形式:** -[`CONTRIBUTING.md`](https://github.com/toapuro/modding-notes/blob/master/CONTRIBUTING.md) に基づき、以下の形式を使用してください。 +以下のいずれかの形式を使用してください。 - `Add: <内容>` : ドキュメントの新規追加 - `Update: <内容>` : ドキュメントの更新 -- `Fix: <内容>` : 誤字脱字やバグの修正 +- `Fix: <内容>` : ドキュメントの誤字脱字や表現の修正、バグの修正 +- `Ci: <内容>` : GitHub Actions などの CI 設定の変更 ```bash title="Terminal" git add . -git commit -m "Update: 編集方法のページを追加" +git commit -m "Add: 編集方法のページを追加" git push origin main ``` @@ -109,9 +115,9 @@ GitHub 上でオリジナルのリポジトリに対してプルリクエスト ```java title="Main.java" public class Main { public static void main(String[] args) { - System.out.println("Hello World!"); - } - } + System.out.println("Hello World!"); + } +} ``` ```` @@ -120,9 +126,9 @@ public class Main { ```java title="Main.java" public class Main { public static void main(String[] args) { - System.out.println("Hello World!"); - } - } + System.out.println("Hello World!"); + } +} ``` 詳細な説明は、 [Code blocks - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) を参照してください。 @@ -170,7 +176,7 @@ public class Main { ## スタイルガイド !!! warning "要検討" - + ## 禁止事項 原稿には、以下の内容を含むことはできません。注意してください