File tree Expand file tree Collapse file tree 4 files changed +42
-18
lines changed Expand file tree Collapse file tree 4 files changed +42
-18
lines changed Original file line number Diff line number Diff line change
1
+ # Dev the Document
2
+
3
+ ## Working principle
4
+
5
+ I modified the [ ruabick] ( https://github.com/dewfall123/ruabick ) plugin o read the .md file and map the generated path。
6
+
7
+ ### plugins:
8
+
9
+ - ` @vue-hooks-plus/vite-plugin-gen-temp ` dynamically generate md files.
10
+ - ` @vue-hooks-plus/vitepress-demo-block ` demo block at the md files.
11
+ - ` @vue-hooks-plus/vitepress ` transformation based on vitepress to support internationalization.
12
+ - ` @vue-hooks-plus/md-demo-plugins ` apply demo block.
13
+
14
+ [ Source] ( https://github.com/InhiblabCore/plugins )
15
+
16
+ ## Start
17
+
18
+ need run initial at ` packages/hooks ` folder.
19
+
20
+ ``` bash
21
+
22
+ pnpm initial
23
+
24
+ ```
25
+
26
+ Check if a .docs folder is generated in your directory。If it fails, it cannot be started and needs to be re-run ` initial ` 👆 .
27
+
28
+ next, vitepress run .docs
29
+
30
+ ``` bash
31
+
32
+ pnpm docs:dev
33
+
34
+ ```
35
+
36
+ If the page startup is blank, you need to refresh the page.
Original file line number Diff line number Diff line change @@ -64,13 +64,9 @@ import useRequest from 'vue-hooks-plus/es/useRequest'
64
64
- [ English Documentations] ( https://inhiblabcore.github.io/docs/hooks/en )
65
65
- [ 中文文档] ( https://inhiblabcore.github.io/docs/hooks )
66
66
67
- ## 🕹️ Dev the document
67
+ ## 🕹️ Document Effects
68
68
69
- ```
70
- <!-- need run initial -->
71
-
72
- npm run docs:dev
73
- ```
69
+ Start documentation via [ Dev Document Guide] ( ./DEV_DOCUMENT.md ) .
74
70
75
71
## 🪴 Project Activity
76
72
Original file line number Diff line number Diff line change @@ -64,13 +64,9 @@ import useRequest from 'vue-hooks-plus/es/useRequest'
64
64
- [ English Documentations] ( https://inhiblab-core.gitee.io/docs/hooks/en )
65
65
- [ 中文文档] ( https://inhiblab-core.gitee.io/docs/hooks )
66
66
67
- ## 🕹️ 调试文档
67
+ ## 🕹️ 文档效果
68
68
69
- ```
70
- <!-- need run initial -->
71
-
72
- npm run docs:dev
73
- ```
69
+ 通过 [ Dev Document Guide] ( ./DEV_DOCUMENT.md ) 启动文档。
74
70
75
71
# 🪴 项目活动
76
72
Original file line number Diff line number Diff line change @@ -64,13 +64,9 @@ import useRequest from 'vue-hooks-plus/es/useRequest'
64
64
- [ English Documentations] ( https://inhiblabcore.github.io/docs/hooks/en )
65
65
- [ 中文文档] ( https://inhiblabcore.github.io/docs/hooks )
66
66
67
- ## 🕹️ Dev the document
67
+ ## 🕹️ Document Effects
68
68
69
- ```
70
- <!-- need run initial -->
71
-
72
- npm run docs:dev
73
- ```
69
+ Start documentation via [ Dev Document Guide] ( ./DEV_DOCUMENT.md ) .
74
70
75
71
## 🪴 Project Activity
76
72
You can’t perform that action at this time.
0 commit comments