docs: 添加 twoslash (#126)

DevOpen-Club · Mar 17, 2024 · 8c40341 · 8c40341
1 parent 7b53bd9
commit 8c40341
Show file tree

Hide file tree

Showing 7 changed files with 661 additions and 6 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress'
+import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
 
 export default defineConfig({
   title: 'Fanbook API Node.js SDK',
@@ -7,6 +8,18 @@ export default defineConfig({
     ['link', { rel: 'icon', href: '/icon/fanbook.svg' }],
   ],
   lang: 'zh-CN',
+  markdown: {
+    codeTransformers: [
+      transformerTwoslash({
+        explicitTrigger: false,
+        twoslashOptions: {
+          handbookOptions: {
+            noErrors: true,
+          },
+        },
+      }),
+    ],
+  },
   themeConfig: {
     nav: [
       { text: '首页', link: '/' },

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -0,0 +1,11 @@
+import Theme from 'vitepress/theme'
+import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client'
+import '@shikijs/vitepress-twoslash/style.css'
+import type { EnhanceAppContext } from 'vitepress'
+
+export default {
+  extends: Theme,
+  enhanceApp({ app }: EnhanceAppContext) {
+    app.use(TwoslashFloatingVue)
+  },
+}
diff --git a/docs/package.json b/docs/package.json
@@ -1,3 +1,6 @@
 {
-  "type": "module"
+  "type": "module",
+  "devDependencies": {
+    "fanbook-api-node-sdk": "link:.."
+  }
 }
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml
diff --git a/docs/reference/api-calling.md b/docs/reference/api-calling.md
@@ -120,8 +120,8 @@ console.log(await bot.sendMessage(CHAT_ID, CONTENT, CONTENT))
 ```ts
 import { Bot } from 'fanbook-api-node-sdk'
 
-const BOT_TOKEN = '在此填入你的机器人令牌'
-const bot = new Bot(BOT_TOKEN, {
+// ---cut---
+const bot = new Bot('在此填入你的机器人令牌', {
   axios: { // axios 选项
     timeout: 3 * 1000,
     timeoutErrorMessage: 'Timeout 3000ms',
@@ -131,12 +131,12 @@ const bot = new Bot(BOT_TOKEN, {
 
 对于 SDK 还未支持的 API，你可以直接使用 axios 实例：
 
-```ts
+```ts{7}
 import { Bot } from 'fanbook-api-node-sdk'
 
-const BOT_TOKEN = '在此填入你的机器人令牌'
-const bot = new Bot(BOT_TOKEN)
+const bot = new Bot('在此填入你的机器人令牌')
 
+// ---cut---
 // baseURL 是 `https://a1.fanbook.mobi/api/bot/${this.token}`
 await bot.axios.post('/path/to/api')
 ```

diff --git a/package.json b/package.json
@@ -41,6 +41,7 @@
   "devDependencies": {
     "@antfu/eslint-config": "^2.6.3",
     "@inquirer/prompts": "^4.0.0",
+    "@shikijs/vitepress-twoslash": "^1.2.0",
     "@swc/core": "^1.3.100",
     "@swc/helpers": "^0.5.3",
     "@swc/jest": "^0.2.29",