docs: update rspress, add SourceCode

Yukiniro · Dec 19, 2023 · cc930dd · cc930dd
1 parent 866740e
commit cc930dd
Show file tree

Hide file tree

Showing 4 changed files with 1,064 additions and 1,388 deletions.
diff --git a/site/docs/en/api/index.mdx b/site/docs/en/api/index.mdx
@@ -1,7 +1,11 @@
 # API
 
+import { SourceCode } from 'rspress/theme'
+
 ## subscribe
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L107' />
+
 Subscribe the key's keyboard event.
 
 - Params
@@ -30,6 +34,8 @@ unsubscribe();
 
 ## on
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L251' />
+
 `on` is an alias for `subscribe`.
 
 :::info
@@ -38,6 +44,8 @@ Why is there an alias? Because `on` and `off` is more in line with the semantics
 
 ## off
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L262' />
+
 `off` could cancel the event listener.
 
 - Params
@@ -55,6 +63,8 @@ If the `handler` and `options` is not set, all event listeners of the key will b
 
 ## getScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L187' />
+
 Get the scope of the current keyboard event.
 
 ```javascript
@@ -65,6 +75,8 @@ const scope = getScope();
 
 ## setScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L195' />
+
 Set the scope of the current keyboard event.
 
 - Params
@@ -78,6 +90,8 @@ setScope("scope");
 
 ## deleteScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L206' />
+
 Delete the scope of the current keyboard event.
 
 - Params
@@ -91,6 +105,8 @@ deleteScope("scope");
 
 ## enable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L226' />
+
 Enable the key event.
 
 ```javascript
@@ -101,6 +117,8 @@ enable();
 
 ## disable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L233' />
+
 Disable the key event.
 
 ```javascript
@@ -111,6 +129,8 @@ disable();
 
 ## isEnable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L240' />
+
 Get the status of the key event.
 
 ```javascript
@@ -121,6 +141,8 @@ const status = isEnable();
 
 ## clearAll
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L216' />
+
 Clear all key events.
 
 ```javascript

diff --git a/site/docs/zh/api/index.mdx b/site/docs/zh/api/index.mdx
@@ -1,7 +1,11 @@
 # API
 
+import { SourceCode } from 'rspress/theme'
+
 ## subscribe
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L107' />
+
 订阅键盘事件。
 
 - 参数
@@ -30,6 +34,8 @@ unsubscribe();
 
 ## on
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L251' />
+
 `on` 是 `subscribe` 的别名。
 
 :::info
@@ -38,6 +44,8 @@ unsubscribe();
 
 ## off
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L262' />
+
 `off` 可以取消事件监听器。
 
 - Params
@@ -55,6 +63,8 @@ unsubscribe();
 
 ## getScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L187' />
+
 获取当前键盘事件的范围。
 
 ```javascript
@@ -65,6 +75,8 @@ const scope = getScope();
 
 ## setScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L195' />
+
 设置当前键盘事件的范围。
 
 - 参数
@@ -78,6 +90,8 @@ setScope("scope");
 
 ## deleteScope
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L206' />
+
 删除指定键盘事件的范围。
 
 - Params
@@ -91,6 +105,8 @@ deleteScope("scope");
 
 ## enable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L226' />
+
 启用键盘事件。
 
 ```javascript
@@ -101,6 +117,8 @@ enable();
 
 ## disable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L233' />
+
 禁用键盘事件。
 
 ```javascript
@@ -111,6 +129,8 @@ disable();
 
 ## isEnable
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L240' />
+
 获取键盘事件的状态。
 
 ```javascript
@@ -121,6 +141,8 @@ const status = isEnable();
 
 ## clearAll
 
+<SourceCode href='https://github.com/Yukiniro/toukey/blob/master/src/index.ts#L216' />
+
 清除所有键盘事件。
 
 ```javascript

diff --git a/site/package.json b/site/package.json
@@ -8,7 +8,7 @@
     "preview": "rspress preview"
   },
   "dependencies": {
-    "rspress": "^1.7.5"
+    "rspress": "^1.8.3"
   },
   "devDependencies": {
     "@types/node": "^16"