nextra-docs

apps/nextra-docs/pages/_meta.json

@@ -1,9 +1,14 @@
 {
-  "index": "Introduction",
-  "another": "Another Page",
-  "advanced": "Advanced (A Folder)",
-  "about": {
-    "title": "About",
+  "index": {
+    "title": "主页",
+    "type": "page",
+    "theme": {
+      "layout": "full"
+    },
+    "display": "hidden"
+  },
+  "apis": {
+    "title": "Api 接口",
     "type": "page"
   },
   "contact": {

apps/nextra-docs/pages/apis/config.mdx

@@ -0,0 +1,141 @@
+import { OptionTable } from "@components/OptionTable";
+
+# Config 配置信息
+
+- [config/findUnique](#获取配置信息) 获取配置信息
+- [config/upsert](#更新配置信息) 更新配置信息
+
+## 获取配置信息
+
+`config/findUnique`
+
+### 使用方式
+
+TRPC
+
+```tsx copy
+const configQuery = trpc.config.findUnique.useQuery();
+
+console.log(configQuery.data);
+```
+
+HTTP
+
+```sh
+GET /trpc/config/findUnique
+```
+
+### 参数
+
+No Params
+
+### 返回值
+
+<OptionTable
+  options={[
+    ["name", "string", "`config` 唯一值"],
+    ["language", "string", "语言"],
+    [
+      "color",
+      "string",
+      <>
+        外观 | 配色，具体可查看{" "}
+        <a href="https://daisyui.com/docs/themes/">daisyui themes</a>
+      </>,
+    ],
+    ["theme", "string", "WEB 主题"],
+    [
+      "serverPort",
+      "number",
+      <>
+        服务端 PORT <code>9301-9500</code>
+      </>,
+    ],
+    [
+      "clientPort",
+      "number",
+      <>
+        客户端 PORT <code>9301-9500</code>
+      </>,
+    ],
+    ["ip", "string", "当前 IP 改变后会自动更新"],
+  ]}
+/>
+
+## 更新配置信息
+
+`config/upsert`
+
+### 请求参数
+
+<OptionTable
+  options={[
+    ["language?", `"zh-cn" | "en-us" | "zh-tw" | undefined`, "设置语言"],
+    [
+      "theme?",
+      <>
+        默认值 <code>taga-basic</code>
+      </>,
+      "设置主题",
+    ],
+    [
+      "color?",
+      <>
+        参考 <a href="https://daisyui.com/docs/themes/">daisyui themes</a>
+      </>,
+      "设置配色",
+    ],
+  ]}
+/>
+
+### 使用方式
+
+TRPC
+
+```ts copy
+const { mutate: updateConfig } = trpc.config.upsert.useMutation();
+
+// 传入需要更新的字段
+updateConfig.mutate({
+  language: "zh-cn",
+});
+```
+
+HTTP
+
+```sh
+POST /trpc/config/upsert
+```
+
+### 返回值
+
+<OptionTable
+  options={[
+    ["name", "string", "`config` 唯一值"],
+    ["language", "string", "语言"],
+    [
+      "color",
+      "string",
+      <>
+        外观 | 配色，具体可查看{" "}
+        <a href="https://daisyui.com/docs/themes/">daisyui themes</a>
+      </>,
+    ],
+    ["theme", "string", "WEB 主题"],
+    [
+      "serverPort",
+      "number",
+      <>
+        服务端 PORT <code>9301-9500</code>
+      </>,
+    ],
+    [
+      "clientPort",
+      "number",
+      <>
+        客户端 PORT <code>9301-9500</code>
+      </>,
+    ],
+    ["ip", "string", "当前 IP 改变后会自动更新"],
+  ]}
+/>