summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-25 12:31:38 +0900
committerGitHub <noreply@github.com>2026-01-25 12:31:38 +0900
commit8e9f69636c6ffaae4b6be6274835d583598c9357 (patch)
tree12ea378db56a45af8de84ff96c217b4c4d17a3ec
parente3387a401c6d0d094b3afa734558e9257465a42b (diff)
parent4c6d5b6b7ab33745dcc7a857931a17e98ea454d7 (diff)
downloadLunaticChat-8e9f69636c6ffaae4b6be6274835d583598c9357.tar.gz
LunaticChat-8e9f69636c6ffaae4b6be6274835d583598c9357.tar.bz2
LunaticChat-8e9f69636c6ffaae4b6be6274835d583598c9357.zip
Merge pull request #67 from m1sk9/fix-divide-sidebar
docs: Fix divide sidebar
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md53
-rw-r--r--.github/workflows/ci.yaml3
-rw-r--r--.github/workflows/dokka.yaml7
-rw-r--r--docs/.vitepress/config.mts230
-rw-r--r--docs/.vitepress/config/en.ts114
-rw-r--r--docs/.vitepress/config/ja.ts114
-rw-r--r--docs/src/en/guide/player/direct-message.md2
-rw-r--r--docs/src/en/index.md2
-rw-r--r--docs/src/guide/player/direct-message.md2
-rw-r--r--docs/src/index.md2
-rw-r--r--docs/src/public/direct-message/minecraft-player-sound.png (renamed from docs/src/static/direct-message/minecraft-player-sound.png)bin1609414 -> 1609414 bytes
-rw-r--r--docs/src/public/favicon.ico (renamed from docs/src/static/favicon.ico)bin4286 -> 4286 bytes
-rw-r--r--docs/src/public/icon.png (renamed from docs/src/static/icon.png)bin122601 -> 122601 bytes
13 files changed, 241 insertions, 288 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index a0728d2..0000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,53 +0,0 @@
-## Description
-
-<!-- Provide a clear and concise description of what this PR changes -->
-
-## Type of Change
-
-<!-- Check the relevant boxes -->
-
-- [ ] Bug fix (non-breaking change that fixes an issue)
-- [ ] New feature (non-breaking change that adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Documentation update
-- [ ] Refactoring / Code cleanup
-- [ ] Other (please describe):
-
-## Related Issues
-
-<!-- Link any related issues here -->
-
-close #
-
-## Testing
-
-<!-- Describe the testing you performed to verify your changes -->
-
-**Test Environment:**
-- Minecraft Version:
-- Paper Version:
-- Java Version:
-
-**Test Steps:**
-1.
-2.
-3.
-
-## Checklist
-
-<!-- Check all that apply -->
-
-- [ ] Code follows ktlint style guidelines (`./gradlew ktlintCheck`)
-- [ ] Build passes (`./gradlew build`)
-- [ ] Tested on Paper server
-- [ ] Updated documentation if needed
-- [ ] No breaking changes (or documented if necessary)
-- [ ] All new and existing tests pass
-
-## Screenshots / Logs (if applicable)
-
-<!-- Add any relevant screenshots or logs here -->
-
-## Additional Context
-
-<!-- Add any other context about the PR here -->
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 6cab034..8c561d2 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -43,6 +43,9 @@ jobs:
- name: Build with shadowJar
run: ./gradlew :platform-paper:shadowJar --parallel --no-daemon
+ - name: Generate Dokka
+ run: ./gradlew :dokka:dokkaGenerate --no-daemon
+
- name: Upload build artifact
uses: actions/upload-artifact@v6
if: success()
diff --git a/.github/workflows/dokka.yaml b/.github/workflows/dokka.yaml
index 376dede..9f79ef2 100644
--- a/.github/workflows/dokka.yaml
+++ b/.github/workflows/dokka.yaml
@@ -4,9 +4,6 @@ on:
push:
branches:
- main
- pull_request:
- branches:
- - main
permissions:
contents: read
@@ -34,18 +31,16 @@ jobs:
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- - name: Generate JavaDoc with Dokka
+ - name: Generate Dokka
run: ./gradlew :dokka:dokkaGenerate --no-daemon
- name: Upload artifact
- if: github.event_name == 'push'
id: lunaticchat_dokka
uses: actions/upload-pages-artifact@v4
with:
path: dokka/build/dokka/html
deploy:
- if: github.event_name == 'push'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index f88316e..7e314f0 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -1,4 +1,6 @@
import { defineConfig } from 'vitepress';
+import { ja } from './config/ja';
+import { en } from './config/en';
export default defineConfig({
title: 'LunaticChat Docs',
@@ -7,7 +9,7 @@ export default defineConfig({
cleanUrls: true,
srcDir: './src',
outDir: './dist',
- head: [['link', { rel: 'icon', href: '/static/favicon.ico' }]],
+ head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
themeConfig: {
socialLinks: [
{ icon: 'github', link: 'https://github.com/m1sk9/LunaticChat' },
@@ -17,235 +19,13 @@ export default defineConfig({
root: {
label: '日本語',
lang: 'ja-JP',
- themeConfig: {
- nav: [
- { text: 'ガイド', link: '/guide/getting-started' },
- { text: 'リファレンス', link: '/reference' },
- ],
- sidebar: {
- '/guide/': [
- {
- text: 'はじめる',
- link: '/guide/getting-started',
- },
- {
- text: 'LunaticChat について',
- link: '/guide/about',
- },
- {
- text: 'サーバー管理者向け',
- items: [
- {
- text: 'キャッシュシステム',
- link: '/guide/admin/cache',
- },
- {
- text: '設定',
- link: '/guide/admin/configuration',
- },
- {
- text: 'Velocity 連携',
- link: '/guide/admin/velocity',
- },
- ],
- },
- {
- text: 'プレイヤー向け',
- items: [
- {
- text: 'チャンネルチャット',
- link: '/guide/player/channel-chat',
- },
- {
- text: 'ダイレクトメッセージ',
- link: '/guide/player/direct-message',
- },
- {
- text: 'ローマ字変換',
- link: '/guide/player/japanese-romanization',
- },
- ],
- },
- {
- text: 'パッチノート',
- items: [
- {
- text: 'プラグイン',
- link: '/guide/patch-notes/plugin',
- },
- {
- text: 'キャッシュファイル',
- link: '/guide/patch-notes/cache-file',
- },
- ],
- },
- ],
- '/reference/': [
- {
- text: 'パーミッション',
- link: '/reference/permissions',
- },
- {
- text: 'コマンド',
- items: [
- {
- text: '/tell',
- link: '/reference/commands/tell',
- },
- {
- text: '/reply',
- link: '/reference/commands/reply',
- },
- {
- text: '/jp',
- link: '/reference/commands/jp',
- },
- {
- text: '/notice',
- link: '/reference/commands/notice',
- },
- {
- text: '/lc',
- items: [
- {
- text: '/lc settings',
- link: '/reference/commands/lc/settings',
- },
- {
- text: '/lc status',
- link: '/reference/commands/lc/status',
- },
- ],
- },
- ],
- },
- ],
- },
- editLink: {
- pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path',
- text: 'GitHub で編集',
- },
- footer: {
- copyright: 'Copyright © 2026 m1sk9',
- },
- },
+ themeConfig: ja,
},
en: {
label: 'English',
lang: 'en-US',
link: '/en/',
- themeConfig: {
- nav: [
- { text: 'Guide', link: '/en/guide/getting-started' },
- { text: 'Reference', link: '/en/reference' },
- ],
- sidebar: {
- '/en/guide/': [
- {
- text: 'Getting Started',
- link: '/en/guide/getting-started',
- },
- {
- text: 'About LunaticChat',
- link: '/en/guide/about',
- },
- {
- text: 'For Server Administrators',
- items: [
- {
- text: 'Cache System',
- link: '/en/guide/admin/cache',
- },
- {
- text: 'Configuration',
- link: '/en/guide/admin/configuration',
- },
- {
- text: 'Velocity Integration',
- link: '/en/guide/admin/velocity',
- },
- ],
- },
- {
- text: 'For Players',
- items: [
- {
- text: 'Channel Chat',
- link: '/en/guide/player/channel-chat',
- },
- {
- text: 'Direct Messages',
- link: '/en/guide/player/direct-message',
- },
- {
- text: 'Romanization Conversion',
- link: '/en/guide/player/japanese-romanization',
- },
- ],
- },
- {
- text: 'Patch Notes',
- items: [
- {
- text: 'Plugin',
- link: '/en/guide/patch-notes/plugin',
- },
- {
- text: 'Cache File',
- link: '/en/guide/patch-notes/cache-file',
- },
- ],
- },
- ],
- '/en/reference/': [
- {
- text: 'Permissions',
- link: '/en/reference/permissions',
- },
- {
- text: 'Commands',
- items: [
- {
- text: '/tell',
- link: '/en/reference/commands/tell',
- },
- {
- text: '/reply',
- link: '/en/reference/commands/reply',
- },
- {
- text: '/jp',
- link: '/en/reference/commands/jp',
- },
- {
- text: '/notice',
- link: '/en/reference/commands/notice',
- },
- {
- text: '/lc',
- items: [
- {
- text: '/lc settings',
- link: '/en/reference/commands/lc/settings',
- },
- {
- text: '/lc status',
- link: '/en/reference/commands/lc/status',
- },
- ],
- },
- ],
- },
- ],
- },
- editLink: {
- pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path',
- text: 'Edit this page on GitHub',
- },
- footer: {
- copyright: 'Copyright © 2026 m1sk9',
- },
- },
+ themeConfig: en,
},
},
});
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
new file mode 100644
index 0000000..0f83c9e
--- /dev/null
+++ b/docs/.vitepress/config/en.ts
@@ -0,0 +1,114 @@
+import type { DefaultTheme } from 'vitepress';
+
+export const en: DefaultTheme.Config = {
+ nav: [
+ { text: 'Guide', link: '/en/guide/getting-started' },
+ { text: 'Reference', link: '/en/reference' },
+ ],
+ sidebar: {
+ '/en/guide/': [
+ {
+ text: 'Getting Started',
+ link: '/en/guide/getting-started',
+ },
+ {
+ text: 'About LunaticChat',
+ link: '/en/guide/about',
+ },
+ {
+ text: 'For Server Administrators',
+ items: [
+ {
+ text: 'Cache System',
+ link: '/en/guide/admin/cache',
+ },
+ {
+ text: 'Configuration',
+ link: '/en/guide/admin/configuration',
+ },
+ {
+ text: 'Velocity Integration',
+ link: '/en/guide/admin/velocity',
+ },
+ ],
+ },
+ {
+ text: 'For Players',
+ items: [
+ {
+ text: 'Channel Chat',
+ link: '/en/guide/player/channel-chat',
+ },
+ {
+ text: 'Direct Messages',
+ link: '/en/guide/player/direct-message',
+ },
+ {
+ text: 'Romanization Conversion',
+ link: '/en/guide/player/japanese-romanization',
+ },
+ ],
+ },
+ {
+ text: 'Patch Notes',
+ items: [
+ {
+ text: 'Plugin',
+ link: '/en/guide/patch-notes/plugin',
+ },
+ {
+ text: 'Cache File',
+ link: '/en/guide/patch-notes/cache-file',
+ },
+ ],
+ },
+ ],
+ '/en/reference/': [
+ {
+ text: 'Permissions',
+ link: '/en/reference/permissions',
+ },
+ {
+ text: 'Commands',
+ items: [
+ {
+ text: '/tell',
+ link: '/en/reference/commands/tell',
+ },
+ {
+ text: '/reply',
+ link: '/en/reference/commands/reply',
+ },
+ {
+ text: '/jp',
+ link: '/en/reference/commands/jp',
+ },
+ {
+ text: '/notice',
+ link: '/en/reference/commands/notice',
+ },
+ {
+ text: '/lc',
+ items: [
+ {
+ text: '/lc settings',
+ link: '/en/reference/commands/lc/settings',
+ },
+ {
+ text: '/lc status',
+ link: '/en/reference/commands/lc/status',
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ editLink: {
+ pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path',
+ text: 'Edit this page on GitHub',
+ },
+ footer: {
+ copyright: 'Copyright © 2026 m1sk9',
+ },
+};
diff --git a/docs/.vitepress/config/ja.ts b/docs/.vitepress/config/ja.ts
new file mode 100644
index 0000000..5264820
--- /dev/null
+++ b/docs/.vitepress/config/ja.ts
@@ -0,0 +1,114 @@
+import type { DefaultTheme } from 'vitepress';
+
+export const ja: DefaultTheme.Config = {
+ nav: [
+ { text: 'ガイド', link: '/guide/getting-started' },
+ { text: 'リファレンス', link: '/reference' },
+ ],
+ sidebar: {
+ '/guide/': [
+ {
+ text: 'はじめる',
+ link: '/guide/getting-started',
+ },
+ {
+ text: 'LunaticChat について',
+ link: '/guide/about',
+ },
+ {
+ text: 'サーバー管理者向け',
+ items: [
+ {
+ text: 'キャッシュシステム',
+ link: '/guide/admin/cache',
+ },
+ {
+ text: '設定',
+ link: '/guide/admin/configuration',
+ },
+ {
+ text: 'Velocity 連携',
+ link: '/guide/admin/velocity',
+ },
+ ],
+ },
+ {
+ text: 'プレイヤー向け',
+ items: [
+ {
+ text: 'チャンネルチャット',
+ link: '/guide/player/channel-chat',
+ },
+ {
+ text: 'ダイレクトメッセージ',
+ link: '/guide/player/direct-message',
+ },
+ {
+ text: 'ローマ字変換',
+ link: '/guide/player/japanese-romanization',
+ },
+ ],
+ },
+ {
+ text: 'パッチノート',
+ items: [
+ {
+ text: 'プラグイン',
+ link: '/guide/patch-notes/plugin',
+ },
+ {
+ text: 'キャッシュファイル',
+ link: '/guide/patch-notes/cache-file',
+ },
+ ],
+ },
+ ],
+ '/reference/': [
+ {
+ text: 'パーミッション',
+ link: '/reference/permissions',
+ },
+ {
+ text: 'コマンド',
+ items: [
+ {
+ text: '/tell',
+ link: '/reference/commands/tell',
+ },
+ {
+ text: '/reply',
+ link: '/reference/commands/reply',
+ },
+ {
+ text: '/jp',
+ link: '/reference/commands/jp',
+ },
+ {
+ text: '/notice',
+ link: '/reference/commands/notice',
+ },
+ {
+ text: '/lc',
+ items: [
+ {
+ text: '/lc settings',
+ link: '/reference/commands/lc/settings',
+ },
+ {
+ text: '/lc status',
+ link: '/reference/commands/lc/status',
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ editLink: {
+ pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path',
+ text: 'GitHub で編集',
+ },
+ footer: {
+ copyright: 'Copyright © 2026 m1sk9',
+ },
+};
diff --git a/docs/src/en/guide/player/direct-message.md b/docs/src/en/guide/player/direct-message.md
index 2cbc084..460de51 100644
--- a/docs/src/en/guide/player/direct-message.md
+++ b/docs/src/en/guide/player/direct-message.md
@@ -60,6 +60,6 @@ This notification sound depends on the **Players** category volume setting on th
If you cannot hear LunaticChat's notification sound, check your client's volume settings.
-![](/static/direct-message/minecraft-player-sound.png)
+![](/direct-message/minecraft-player-sound.png)
:::
diff --git a/docs/src/en/index.md b/docs/src/en/index.md
index ce77a87..c88e080 100644
--- a/docs/src/en/index.md
+++ b/docs/src/en/index.md
@@ -19,7 +19,7 @@ hero:
text: GitHub
link: https://github.com/m1sk9/LunaticChat
image:
- src: /static/icon.png
+ src: /icon.png
alt: LunaticChat Logo
features:
diff --git a/docs/src/guide/player/direct-message.md b/docs/src/guide/player/direct-message.md
index 78de1c3..b6f1424 100644
--- a/docs/src/guide/player/direct-message.md
+++ b/docs/src/guide/player/direct-message.md
@@ -60,6 +60,6 @@ v0.4.0 以降,ダイレクトメッセージの通知設定を変更できる
LunaticChat の通知音が聞こえない場合は,クライアントの音量設定を確認してください.
-![](/static/direct-message/minecraft-player-sound.png)
+![](/direct-message/minecraft-player-sound.png)
:::
diff --git a/docs/src/index.md b/docs/src/index.md
index 272e3a0..2d06bdd 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -19,7 +19,7 @@ hero:
text: GitHub
link: https://github.com/m1sk9/LunaticChat
image:
- src: /static/icon.png
+ src: /icon.png
alt: LunaticChat Logo
features:
diff --git a/docs/src/static/direct-message/minecraft-player-sound.png b/docs/src/public/direct-message/minecraft-player-sound.png
index 56059e5..56059e5 100644
--- a/docs/src/static/direct-message/minecraft-player-sound.png
+++ b/docs/src/public/direct-message/minecraft-player-sound.png
Binary files differ
diff --git a/docs/src/static/favicon.ico b/docs/src/public/favicon.ico
index 46c0cad..46c0cad 100644
--- a/docs/src/static/favicon.ico
+++ b/docs/src/public/favicon.ico
Binary files differ
diff --git a/docs/src/static/icon.png b/docs/src/public/icon.png
index 064445a..064445a 100644
--- a/docs/src/static/icon.png
+++ b/docs/src/public/icon.png
Binary files differ