Merge pull request #23 from GiganticMinecraft/add-plugins

feat: 目次, Callout プラグインの追加

.github/CONTRIBUTING.md

@@ -30,6 +30,19 @@ cargo install mdbook
 
 ただしリファレンスの実体は Markdown のため, 必ずしもブラウザのプレビューを確認する必要はありません. これは Optional です.
 
+#### プラグイン
+
+mdbook にはプラグイン機能があり, このリポジトリでは以下のプラグインを使用しています.
+
+- [`mdBook-pagetoc`](https://github.com/slowsage/mdbook-pagetoc)
+- [`mdbook-alerts`](https://github.com/lambdalisue/rs-mdbook-alerts)
+
+`mdbook-alerts` は `cargo` でインストールできます
+
+```sh
+cargo install mdbook-alerts mdbook-pagetoc
+```
+
 ### プレビュー表示する
 
 以下のコマンドでローカル上の CommandReference をプレビュー表示できます.

.github/workflows/deploy.yaml

@@ -17,17 +17,39 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      # https://github.com/rust-lang/mdBook/releases/tag/v0.4.40
+      MDBOOK_VERSION: 0.4.40
+
+      # https://github.com/slowsage/mdbook-pagetoc/releases/tag/v0.2.0
+      MDBOOK_PAGETOC_VERSION: 0.2.0
+
+      # https://github.com/lambdalisue/rs-mdbook-alerts/releases/tag/v0.5.2
+      MDBOOK_ALERTS_VERSION: 0.5.2
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
       - name: Install mdbook
         uses: peaceiris/actions-mdbook@v2
         with:
-          mdbook-version: 'latest'
+          mdbook-version: ${{ env.MDBOOK_VERSION }}
+
+      - name: Setup cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          prefix-key: "dev-guide/gh-actions-cache"
+
+      - name: Install mdbook plugins
+        run: |
+          cargo install mdbook-pagetoc --version ${{ env.MDBOOK_PAGETOC_VERSION }}
+          cargo install mdbook-alerts --version ${{ env.MDBOOK_ALERTS_VERSION }}
 
       - name: Build with mdbook
         run: mdbook build

.gitignore

@@ -1 +1,2 @@
 build/
+theme/

book.toml

@@ -13,3 +13,13 @@ edition = "2021"
 build-dir = "build"
 create-missing = false
 use-default-preprocessors = true
+
+[output.html]
+git-repository-url = "https://github.com/GiganticMinecraft/CommandReference"
+edit-url-template = "https://github.com/GiganticMinecraft/CommandReference/edit/main/{path}"
+additional-css = ["theme/pagetoc.css"]
+additional-js  = ["theme/pagetoc.js"]
+
+[preprocessor.alerts]
+
+[preprocessor.pagetoc]

src/introduction.md

@@ -27,8 +27,4 @@ CommandReference は [GitHub で公開されている][Repository]ため、誰
 
 詳しい参加方法については [CONTRIBUTING.md](https://github.com/GiganticMinecraft/CommandReference/blob/main/.github/CONTRIBUTING.md) をご覧ください.
 
-----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/introduction.md)
-
 [Repository]: https://github.com/GiganticMinecraft/CommandReference

src/player/chat.md

@@ -2,28 +2,12 @@
 
 チャット機能・チャンネル機能 (LunaChat) で使用できるコマンド群。
 
-> **LunaChat のコマンドについて**:
+> [!IMPORTANT]
 >
 > 基本的なコマンド実行は **全サーバー** に対して反映されますが、**`*` が付いたコマンドは実行したサーバーでのみ反映されます。**
 >
 > `/ch hide` などをアルカディアで実行しても、エデンではミュートは適用されません。全てのサーバーで実行する必要があります。ご注意ください。
 
-- [`/jp <ON|OFF>` `*`](#jp-onoff-)
-- [`/tell <プレイヤー名> <メッセージ>`](#tell-プレイヤー名-メッセージ)
-- [`![メッセージ]`](#メッセージ)
-- [`/ch hide player <プレイヤー名>` `*`](#ch-hide-player-プレイヤー名-)
-- [`/ch hide channel <チャンネル名>` `*`](#ch-hide-channel-チャンネル名-)
-- [`/ch unhide player <プレイヤー名>` `*`](#ch-unhide-player-プレイヤー名-)
-- [`/ch unhide channel <チャンネル名>` `*`](#ch-unhide-channel-チャンネル名-)
-- [`/ch hide list`](#ch-hide-list)
-- [`/ch create <チャンネル名>`](#ch-create-チャンネル名)
-- [`/ch join <チャンネル名>`](#ch-join-チャンネル名)
-- [`/ch join !`](#ch-join-)
-- [`/ch leave <チャンネル名>`](#ch-leave-チャンネル名)
-- [`/ch info <チャンネル名>`](#ch-info-チャンネル名)
-- [`/ch list`](#ch-list)
-- [`/ch log ! p=<プレイヤー名>`](#ch-log--pプレイヤー名)
-
 ## `/jp <ON|OFF>` `*`
 
 日本語チャットを有効化/無効化します。
@@ -73,6 +57,8 @@
 
 発言先を切り替えるため、実行以降のチャットは全て指定したチャンネルに送信されます。
 
+> [!TIP]
+>
 > チャンネルに参加したまま **全体チャットにメッセージを送信する場合はメッセージの先頭に [`!`](#メッセージ) をつけます**。
 
 ## `/ch join !`
@@ -93,10 +79,6 @@
 
 サーバー内に存在するチャンネルの一覧を表示します。
 
-> **フォーマット:**
->
-> [チャンネル名] [参加人数]
-
 この際、状態によりチャンネル名の色が以下のように変化します。
 
 | 色 | 意味 |
@@ -109,7 +91,3 @@
 ## `/ch log ! p=<プレイヤー名>`
 
 指定したプレイヤー名のチャットログを表示します。
-
----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/chat.md)

src/player/flying.md

@@ -1,4 +1,4 @@
-# 飛行関連
+# 飛行系
 
 飛行に関するコマンド群。全て棒メニューからでも操作可能です。
 
@@ -15,7 +15,3 @@
 - alias: `/fly end`
 
 飛行可能状態を解除します。
-
----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/flying.md)

src/player/mebius.md

@@ -1,4 +1,4 @@
-# Mebius関連
+# Mebius系
 
 Mebius の操作関連のコマンド群。
 
@@ -25,7 +25,3 @@ Mebiusの素材変換を行います。
 ## `/mebius`
 
 Mebius に関するコマンドを一覧表示します。
-
----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/mebius.md)

src/player/minestack.md

@@ -1,4 +1,4 @@
-# MineStack関連
+# MineStack系
 
 MineStack の操作関連のコマンド群。棒メニューからでも操作可能です。
 
@@ -16,15 +16,11 @@ Minestack の自動収集機能をOFFにします。
 
 指定したカテゴリーの MineStack ページを開きます。
 
-> **例:**
+> [!TIP]
 >
 > - トップページを開く: `/minestack open 0 0`
 > - ガチャ品ページを開く: `/minestack open 7 1`
 
 ## `/minestack store-all`
 
 インベントリに存在するアイテムをすべて MineStack に収納します。 (収納できないアイテムはそのままインベントリに残ります)
-
----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/minestack.md)

src/player/moving.md

@@ -1,18 +1,9 @@
-# 移動系コマンド
+# 移動系
 
 別サーバーへの移動などに使用できるコマンド群。
 
 テレポートは[別ページ](./teleport.md)にまとめています。
 
-- [`/hub`](#hub)
-- [`/spawn`](#spawn)
-- [`/mvspawn`](#mvspawn)
-- [`/rtp`](#rtp)
-- [`/home set <番号>`](#home-set-番号)
-- [`/home warp <番号>`](#home-warp-番号)
-- [`/home name <番号>`](#home-name-番号)
-- [`/server <サーバー名>`](#server-サーバー名)
-
 ## `/hub`
 
 ロビーサーバーへ移動します。 ギガンティック☆整地鯖以外のサーバー (1day / 香川) でも実行できます。
@@ -33,7 +24,9 @@
 
 整地ワールド内のランダムな地点に移動します。棒メニューの **ランダムテレポート** と同じ機能です。
 
-> **注意:** 整地ワールド以外では使用できません。
+> [!WARNING]
+>
+> 整地ワールド以外では使用できません。
 
 ## `/home set <番号>`
 
@@ -51,7 +44,9 @@
 
 指定したサーバーへ移動します。
 
-> **注意:** サーバーへ移動しても所持しているアイテムは一緒に移動しません。 移動先のサーバーへアイテムも一緒に移動したいときは **サーバー間アイテム移動** を使用してください。
+> [!WARNING]
+>
+> サーバーへ移動しても所持しているアイテムは一緒に移動しません。 移動先のサーバーへアイテムも一緒に移動したいときは **サーバー間アイテム移動** を使用してください。
 
 ### 使用できるサーバー名
 
@@ -69,7 +64,3 @@
 
 [^1]: デバッグサーバーへ所有アイテムは移動できません。
 [^2]: 詳細については、公式Discordグループ内のチャンネルをご覧ください。
-
-----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/moving.md)

src/player/other.md

@@ -2,20 +2,6 @@
 
 その他のコマンド群。
 
-- [`/stick`](#stick)
-- [`/ef`](#ef)
-- [`/ef smart`](#ef-smart)
-- [`/hat`](#hat)
-- [`/glist`](#glist)
-- [`/fc craft`](#fc-craft)
-- [`/map`](#map)
-- [`/stickmenu`](#stickmenu)
-- [`/stickmenu b`](#stickmenu-b)
-- [`/present`](#present)
-- [`/ec`](#ec)
-- [`/shareinv`](#shareinv)
-- [`/fd`](#fd)
-
 ## `/stick`
 
 木の棒を召喚します。(木の棒を持って左クリック、右クリックするとメニューを表示します)
@@ -72,8 +58,8 @@
 
 [​「4次元ポケット」][other-function] を開きます。
 
-[other-function]: https://www.seichi.network/otherfuncs
-
-----
+> [!CAUTION]
+>
+> 運営チームから再起動の予告が行われている際に [`/ec`](#ec), [`/shareinv`](#shareinv), [`/fd`](#fd) を使用するのはデータ保護の観点は推奨されません. 最悪の場合データが消失する可能性があります. ご利用をお控えください.
 
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/other.md)
+[other-function]: https://www.seichi.network/otherfuncs

src/player/protection.md

@@ -2,22 +2,6 @@
 
 土地の保護やその管理に使用するコマンド群。
 
-- [`//wand`](#wand)
-- [`//sel`](#sel)
-- [`//pos1`](#pos1)
-- [`//pos2`](#pos2)
-- [`//expand <ブロック数> <方角>`](#expand-ブロック数-方角)
-- [`//contract <ブロック数> <方角>`](#contract-ブロック数-方角)
-- [`/rg claim <領域名>`](#rg-claim-領域名)
-- [`/rg info`](#rg-info)
-- [`/rg list -p <プレイヤー名>`](#rg-list--p-プレイヤー名)
-- [`/rg remove <領域名>`](#rg-remove-領域名)
-- [`/rg addmember <領域名> <プレイヤー名>`](#rg-addmember-領域名-プレイヤー名)
-- [`/rg removemember <領域名> <プレイヤー名>`](#rg-removemember-領域名-プレイヤー名)
-- [`/rg removeowner <領域名> <プレイヤー名>`](#rg-removeowner-領域名-プレイヤー名)
-- [`/rg flag <領域名> <対象フラグ> [-g グループ名] [allow|deny]`](#rg-flag-領域名-対象フラグ--g-グループ名-allowdeny)
-- [`/x-transfer <領域名> <プレイヤー名>`](#x-transfer-領域名-プレイヤー名)
-
 ## `//wand`
 
 保護の範囲設定に使用する木の斧をインベントリに追加します。
@@ -56,7 +40,7 @@
 
 指定したプレイヤーの保護を検索します。
 
-> **注意:**
+> [!IMPORTANT]
 >
 > WorldGuardがMCIDの検索に既に廃止されたMojangのAPIを使用しているため、現状自分のMCID以外は検索できません。
 >
@@ -65,8 +49,6 @@
 > 参考: [プレイヤーの保護検索コマンドが自分自身のMCID以外機能しなくなっている - #不具合報告-ゲーム内](https://discord.com/channels/237758724121427969/1106084808897069117)
 > (整地鯖公式Discordに移動します)
 
-### 管理系
-
 ## `/rg remove <領域名>`
 
 指定した領域名の保護を削除します。
@@ -89,9 +71,10 @@
 
 指定した領域名の保護のオーナーから指定したプレイヤーを削除します。
 
-> **Warning**
+> [!CAUTION]
+>
+> このコマンドは保護のオーナーだけを削除するため、メンバーは削除されません。
 >
-> 保護のオーナーだけを削除するため、メンバーは削除されません。
 > 乗っ取り等を回避するために [**メンバーを最初に削除しましょう**](#rg-removemember-領域名-プレイヤー名)
 
 ## `/rg flag <領域名> <対象フラグ> [-g グループ名] [allow|deny]`
@@ -126,7 +109,3 @@
 ## `/x-transfer <領域名> <プレイヤー名>`
 
 指定した領域名の保護のオーナーを指定したプレイヤーに譲与します。
-
-----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/protection.md)

src/player/teleport.md

@@ -1,16 +1,9 @@
-# プレイヤー間テレポート
+# テレポート系
 
 プレイヤー間のテレポートに関するコマンド群。
 
 サーバー間の移動については [こちら](./moving.md)。
 
-- [`/tpa <プレイヤー名>`](#tpa-プレイヤー名)
-- [`/tpahere <プレイヤー名>`](#tpahere-プレイヤー名)
-- [`/tpaccept`](#tpaccept)
-- [`/tpdeny`](#tpdeny)
-- [`/tpacancel`](#tpacancel)
-- [`/tptoggle`](#tptoggle)
-
 ## `/tpa <プレイヤー名>`
 
 指定したプレイヤーにテレポートリクエストを送信します。
@@ -43,7 +36,3 @@
 - `OFF`: リクエストを自動的に拒否しません。
 
 > **注意:** テレポートリクエストの自動拒否を ON にした場合、申請を自分から送信することは出来なくなります。
-
-----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/player/teleport.md)

src/towny/general.md

@@ -1,13 +1,5 @@
 # Towny: 基本コマンド
 
-- [`/towny`](#towny)
-- [`/towny ?`](#towny-)
-- [`/towny map`](#towny-map)
-- [`/towny prices`](#towny-prices)
-- [`/towny time`](#towny-time)
-- [`/towny top residents [all|town|nation]`](#towny-top-residents-alltownnation)
-- [`/towny top land [all|town|resident]`](#towny-top-land-alltownresident)
-
 ## `/towny`
 
 各コマンドのヘルプ一覧を表示します。
@@ -51,7 +43,3 @@
 | `all` | 全ての町と国 |
 | `town` | 町ごと |
 | `resident` | 住民ごと |
-
-----
-
-[このページを GitHub で編集する](https://github.com/GiganticMinecraft/CommandReference/edit/main/src/towny/general.md)