summaryrefslogtreecommitdiff
path: root/docs/src/reference/index.md
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-10 22:11:45 +0900
committerSho Sakuma <me@m1sk9.dev>2026-01-10 22:11:45 +0900
commitcf34e15ddedb9f8665045389e90f5f198989a23d (patch)
tree0365f024c0760f235ace807cfb7034f7f8f995ab /docs/src/reference/index.md
parent7098bba7b5c516a57e3eaae3f5a3305f8bf5c476 (diff)
downloadLunaticChat-cf34e15ddedb9f8665045389e90f5f198989a23d.tar.gz
LunaticChat-cf34e15ddedb9f8665045389e90f5f198989a23d.tar.bz2
LunaticChat-cf34e15ddedb9f8665045389e90f5f198989a23d.zip
docs: Add LunaticChat docs
Diffstat (limited to 'docs/src/reference/index.md')
-rw-r--r--docs/src/reference/index.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/src/reference/index.md b/docs/src/reference/index.md
new file mode 100644
index 0000000..0563bca
--- /dev/null
+++ b/docs/src/reference/index.md
@@ -0,0 +1,24 @@
+# プレイヤー向けリファレンス
+
+このページは LunaticChat を使用するプレイヤー向けのリファレンスです。
+
+プラグインの導入方法や設定方法については [ガイド](../guide/getting-started.md) を参照してください。
+
+## 凡例
+
+コマンドリファレンスで使用される凡例は以下の通りです。
+
+- `<引数>`: 必須の引数を示します.実行には必ず指定する必要があります.
+- `[引数]`: 任意の引数を示します.実行時に省略可能です.
+- `|`: 複数の選択肢がある場合に使用します.例えば,`<yes|no>` は `yes` または `no` のいずれかを指定することを意味します.
+- `...` : 複数の引数を指定できることを示します.例えば,`<item>...` は複数のアイテムを指定できることを意味します.
+
+## ラベル
+
+以下のようなラベルが記載されている場合は,次のような意味を持ちます.
+
+- <Badge type="info" text="v0.1.0" /> : この機能が LunaticChat バージョン 0.1.0 で導入されたことを示します.
+- <Badge type="tip" text="Paper" /> : この機能が Paper 環境で利用可能であることを示します.
+- <Badge type="tip" text="Velocity" /> : この機能が Velocity 環境で利用可能であることを示します.
+- <Badge type="tip" text="Paper / Velocity" /> : この機能が Paper / Velocity 環境で利用可能であることを示します.
+