Merge pull request #18 from GiganticMinecraft/renewal

mdbook を使ったリニューアル

.github/CODEOWNERS

@@ -1,3 +1 @@
-docs/player/general-command.md @GiganticMinecraft/admin-team
-
-docs/player/towny-command.md @GiganticMinecraft/admin-team
+*.md @GiganticMinecraft/admin-team

.github/CONTRIBUTING.md

@@ -1,38 +1,41 @@
-# コントリビュートガイド (編集中)
+# コントリビュートガイド
 
 ## 主な流れ
 
 1. 自分の GitHub アカウントに [`Fork`](https://github.com/GiganticMinecraft/CommandReference/fork) する
-2. `git clone` を実行し、自分のローカルにリポジトリをクローンする
-3. `git checkout -b <branch-name>` を実行し、新しいブランチを作成する
+2. `git clone` を実行し, 自分のローカルにリポジトリをクローンする
+3. `git checkout -b <branch-name>` を実行し, 新しいブランチを作成する
 4. 編集する
-5. `git commit -am "<コミット内容>` を実行し、コミットする (コンベンショナルコミットは推奨していませんが、ある程度わかりやすいコミットメッセージでコミットしてください。)
+5. `git commit -am "<コミット内容>` を実行し, コミットする (コンベンショナルコミットは推奨していませんが, ある程度わかりやすいコミットメッセージでコミットしてください.)
 6. `git push`
 7. `GiganticMinecraft/CommandReference` に対してプルリクエストを送る
 8. レビューを受ける
 9. マージされる
 10. `cmd.seichi.click` にデプロイされる
-    - デプロイは自動で行われます。
-
-## リファレンスの構成
-
-```text
-.github /
-    - CODEOWNERS -- 特定のファイルに対してレビュワーを強制的に指定するファイル (本来外部貢献者が編集する必要はありません。)
-    - CONTRIBUTING.md -- コントリビュートに関するガイド (本来外部貢献者が編集する必要はありません。)
-.docs /
-    - CNAME -- GitHub Pages で使用するドメインを指定するファイル (本来外部貢献者が編集する必要はありません。)
-    player / -- プレイヤー関連のコマンドリファレンス
-        - general-command.md -- プレイヤーが使用できる全てのコマンドリファレンスを記述するファイル (cmd.seichi.click/player-command)
-        - towny-command.md -- プレイヤーが使用できるTownyのコマンドリファレンスを記述するファイル (cmd.seichi.click/towny-command)
-    - README.md (cmd.seichi.click)
---- (以下略)
+    - デプロイは自動で行われます.
+
+マージするには GiganticMinecraft 運営チームメンバーによるレビューが少なくとも1人必要です.
+
+## 開発方法
+
+### mdbook のインストール方法
+
+CommandReference は [mdbook](https://github.com/rust-lang/mdBook) を使用して制作しているため, ブラウザでのプレビューを確認するには mdbook をインストールする必要があります.
+
+```sh
+cargo install mdbook
 ```
 
-## 使用するエディターについて
+[Rust をインストールしていない場合はバイナリを直接インストールすることもできます](https://github.com/rust-lang/mdBook/releases).
+
+ただしリファレンスの実体は Markdown のため, 必ずしもブラウザのプレビューを確認する必要はありません. これは Optional です.
 
-`CommandReference` を編集する際は [Visual Studio Code](https://code.visualstudio.com/), 拡張機能 [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) の使用を推奨します。
+### プレビュー表示する
 
-コマンドリファレンスの初めは目次で構成されています。この目次は Visual Studio Code の機能で自動生成されているため新しく目次を追加すると自動で更新されます。(Visual Studio Code を使用せず、Vim などのエディタを使用している際は手動で編集してください。)
+以下のコマンドでローカル上の CommandReference をプレビュー表示できます.
 
-![コマンドリファレンスの目次](./image/table-of-contents.png)
+`localhost:3000` に公開されますのでブラウザでアクセスしてください.
+
+```sh
+mdbook serve
+```

.github/workflows/deploy.yaml

@@ -0,0 +1,50 @@
+name: Deploy CommandReference
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    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
+        run: cargo install mdbook
+
+      - name: Build with mdbook
+        run: mdbook build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./book
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1 @@
+build/

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-  "markdown.extension.toc.levels": "2..6"
+  "markdown.extension.toc.levels": "2..2"
 }

README.md

@@ -1,32 +1,21 @@
 # CommandReference
 
-ギガンティック☆整地鯖のゲームサーバー内で使用できるコマンドに関するリファレンス。
+このサイトはギガンティック☆整地鯖内で使用できるコマンドの使い方などをまとめているコマンドリファレンスサイトです。
 
-## 構成
+[運営チームと有志のプレイヤー](https://github.com/GiganticMinecraft/CommandReference/graphs/contributors)により管理しています。
 
-```txt
-docs / -- このディレクトリ配下が GitHub Pages によって公開されます。
-    player / -- プレイヤー向けのコマンドリファレンス
-        general-command.md -- プレイヤーが使用できる全てのコマンドリファレンス
-        towny-command.md -- Towny 関連のコマンドリファレンス
-```
+> [!NOTE]
+>
+> 使い方 (プレイヤー向け) は [こちら](https://cmd.seichi.click/usage.html)
 
-## コントリビュート
+## デプロイ
 
-新しくリファレンスを追加したり、修正する際は、このリポジトリをフォークして、プルリクエストを送ってください。
+CommandReference は [rust-lang/mdbook](https://github.com/rust-lang/mdBook) を使用し制作しています。
 
-1. 自分の GitHub アカウントに [`Fork`](https://github.com/GiganticMinecraft/CommandReference/fork) する
-2. `git clone` を実行し、自分のローカルにリポジトリをクローンする
-3. `git checkout -b <branch-name>` を実行し、新しいブランチを作成する
-4. 編集する
-5. `git commit -am "<コミット内容>` を実行し、コミットする (コンベンショナルコミットは推奨していませんが、ある程度わかりやすいコミットメッセージでコミットしてください。)
-6. `git push`
-7. `GiganticMinecraft/CommandReference` に対してプルリクエストを送る
-8. レビューを受ける
-9. マージされる
-10. `cmd.seichi.click` にデプロイされる
-    - デプロイは自動で行われます。
+デプロイは GitHub Pages を使用しています。これらの設定は運営チームが行っています。
 
-マージするには GiganticMinecraft の `@admin-team` チームに所属しているアカウントによるレビューが少なくとも1人必要です。
+## 貢献
 
-詳しい貢献方法は [CONTRIBUTING.md](./.github/CONTRIBUTING.md) を参照してください。
+CommandReference は誰でも編集に参加することができます。
+
+詳しい参加方法については [CONTRIBUTING.md](.github/CONTRIBUTING.md) をご覧ください.

book.toml

@@ -0,0 +1,15 @@
+[book]
+src = "src"
+title = "GiganticMinecraft CommandReference"
+description = "ギガンティック☆整地鯖内で使用できるコマンドリファレンス"
+authors = ["GiganticMinecraft Admins (m1sk9, KisaragiEffective)", "conarin", "SigureRuri"]
+language = "ja"
+multilingual = false
+
+[rust]
+edition = "2021"
+
+[build]
+build-dir = "build"
+create-missing = false
+use-default-preprocessors = true