Feat/rspress

.github/workflows/gh-pages.yml

@@ -26,8 +26,7 @@ jobs:
         # 文档编译命令，如果是 react 模板需要修改为 npm run docs:build
         run: pnpm doc:build
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          # 文档目录，如果是 react 模板需要修改为 docs-dist
-          publish_dir: ./docs-dist
+          publish_dir: ./doc_build

.gitignore

@@ -43,3 +43,4 @@ yarn.lock
 .dumi/
 docs-dist/
 server/
+doc_build/

docs/en-US/EXAMPLE.mdx

@@ -0,0 +1,20 @@
+import Example from '../../tools/example/index.tsx';
+
+# Example
+
+<Example i18n={{
+  inputLabel: "Please input chinese",
+  outputLabel: "Output pinyin",
+  styleLabelNormal: "Normal Style",
+  styleLabelTone: "Tone Style",
+  styleLabelTone2: "Tone Style(tone2)",
+  styleLabelTo3ne: "Tone Style(to3ne)",
+  styleLabelInitials: "Initial Style",
+  styleLabelFirstLetter: "First Letter Style",
+  styleLabelPassport: "Passport Style",
+  segmentLabel: "Segment",
+  groupLabel: "Group Pinyin",
+  compactLabel: "Compact Output",
+  heteronymLabel: "Heteronym",
+  modeLabel: "Name mode",
+}} />

docs/en-US/_meta.json

@@ -0,0 +1,40 @@
+[
+  {
+    "text": "🛖 HOME",
+    "link": "/",
+    "activeMatch": "^(?:/|/index.html|/(?:zh-CN/|zh-TW/)?index.html)$",
+    "position": "left"
+  },
+  {
+    "text": "🛠️ API",
+    "link": "/api/v4/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?api/",
+    "position": "left",
+    "items": [
+      {
+        "text": "v4 (latest)",
+        "link": "/api/v4/"
+      },
+      {
+        "text": "v3",
+        "link": "/api/v3/"
+      },
+      {
+        "text": "v2",
+        "link": "/api/v2/"
+      }
+    ]
+  },
+  {
+    "text": "✏️ EXAMPLE",
+    "link": "/example/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?example/",
+    "position": "left"
+  },
+  {
+    "text": "🥁 Pinyin Table",
+    "link": "/pinyin-table/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?pinyin-table/",
+    "position": "left"
+  }
+]

docs/api/v4/index.en-US.md → docs/en-US/api/v4/index.md

@@ -1,4 +1,4 @@
-# pīnyīn (v3)
+# pīnyīn (v4)
 
 pinyin, The convert tool of chinese pinyin.
 

docs/en-US/pinyin-table.mdx

@@ -0,0 +1,23 @@
+---
+sidebar: false
+---
+
+import PinyinTable from '../../tools/pinyin-table/pinyin-table.tsx';
+
+# Pinyin Table
+
+This is an audio-enabled Pinyin Table, suitable for pronunciation practice and listening training.
+
+Click on any Pinyin to hear its pronunciation, which will be played in the order of the first tone,
+second tone, third tone, and fourth tone.
+
+<p/>
+
+<PinyinTable i18n={{
+  initials: "Initials",
+  finals: "Finals",
+  medial_vowels_i: "Medial Vowels (i)",
+  medial_vowels_u: "Medial Vowels (u)",
+  medial_vowels_v: "Medial Vowels (ü)",
+}} />
+

docs/ko-KR/EXAMPLE.mdx

@@ -0,0 +1,20 @@
+import Example from '../../tools/example/index.tsx';
+
+# 데모
+
+<Example i18n={{
+  inputLabel: "중국어를 입력해주세요",
+  outputLabel: "병음 출력",
+  styleLabelNormal: "일반 스타일",
+  styleLabelTone: "톤 스타일",
+  styleLabelTone2: "톤 스타일(tone2)",
+  styleLabelTo3ne: "톤 스타일(to3ne)",
+  styleLabelInitials: "초기 스타일",
+  styleLabelFirstLetter: "첫 글자 스타일",
+  styleLabelPassport: "여권 스타일",
+  segmentLabel: "분절",
+  groupLabel: "그룹 병음",
+  compactLabel: "컴팩트 출력",
+  heteronymLabel: "이의어",
+  modeLabel: "이름 모드",
+}} />

docs/ko-KR/_meta.json

@@ -0,0 +1,40 @@
+[
+  {
+    "text": "🛖 홈페이지",
+    "link": "/",
+    "activeMatch": "^(?:/|/index.html|/(?:zh-CN/|zh-TW/)?index.html)$",
+    "position": "left"
+  },
+  {
+    "text": "🛠️ API",
+    "link": "/api/v4/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?api/",
+    "position": "left",
+    "items": [
+      {
+        "text": "v4 (최신)",
+        "link": "/api/v4/"
+      },
+      {
+        "text": "v3",
+        "link": "/api/v3/"
+      },
+      {
+        "text": "v2",
+        "link": "/api/v2/"
+      }
+    ]
+  },
+  {
+    "text": "✏️ 데모",
+    "link": "/example/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?example/",
+    "position": "left"
+  },
+  {
+    "text": "🥁 병음표",
+    "link": "/pinyin-table/",
+    "activeMatch": "^/(?:en-US/|ko-KR/|zh-TW/)?pinyin-table/",
+    "position": "left"
+  }
+]

docs/ko-KR/pinyin-table.mdx

@@ -0,0 +1,22 @@
+---
+sidebar: false
+---
+
+import PinyinTable from '../../tools/pinyin-table/pinyin-table.tsx';
+
+# 병음 표
+
+이것은 음성이 지원되는 병음 표로, 발음 연습과 듣기 훈련에 적합합니다.
+
+병음을 클릭하면 발음을 들을 수 있으며, 제1성, 제2성, 제3성, 제4성 순서로 재생됩니다.
+
+<p/>
+
+<PinyinTable i18n={{
+  initials: "성모",
+  finals: "운모",
+  medial_vowels_i: "개모음 (i)",
+  medial_vowels_u: "개모음 (u)",
+  medial_vowels_v: "개모음 (ü)",
+}} />
+