create-react-docs-ui 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README-zh.md +33 -85
  2. package/README.md +33 -85
  3. package/package.json +44 -42
  4. package/template/index.html +13 -15
  5. package/template/package.json +32 -32
  6. package/template/public/config/site.en.yaml +177 -155
  7. package/template/public/config/site.yaml +179 -166
  8. package/template/public/docs/en/{guide → docs/guide}/configuration.md +195 -149
  9. package/template/public/docs/en/{guide → docs/guide}/installation.md +2 -2
  10. package/template/public/docs/en/docs/guide/quick-start.md +96 -0
  11. package/template/public/docs/en/docs/guide.md +10 -0
  12. package/template/public/docs/en/docs/test/katex-test.md +258 -0
  13. package/template/public/docs/en/docs/test/mdx-test.mdx +136 -0
  14. package/template/public/docs/en/docs/test/test.md +212 -0
  15. package/template/public/docs/en/docs/test.md +9 -0
  16. package/template/public/docs/en/docs.md +16 -0
  17. package/template/public/docs/zh-cn/{guide → docs/guide}/configuration.md +196 -150
  18. package/template/public/docs/zh-cn/{guide → docs/guide}/installation.md +2 -2
  19. package/template/public/docs/zh-cn/{guide → docs/guide}/quick-start.md +13 -25
  20. package/template/public/docs/zh-cn/docs/guide.md +10 -0
  21. package/template/public/docs/zh-cn/docs/test/katex-test.md +260 -0
  22. package/template/public/docs/zh-cn/docs/test/mdx-test.mdx +139 -0
  23. package/template/public/docs/zh-cn/docs/test/test.md +215 -0
  24. package/template/public/docs/zh-cn/docs/test.md +9 -0
  25. package/template/public/docs/zh-cn/docs.md +16 -0
  26. package/template/public/images/yrzx.png +0 -0
  27. package/template/src/components/Alert.tsx +30 -0
  28. package/template/src/components/BadgeList.tsx +38 -0
  29. package/template/src/components/Callout.tsx +20 -0
  30. package/template/src/components/Feature.tsx +15 -0
  31. package/template/src/components/MyTip.tsx +19 -0
  32. package/template/src/components/StepList.tsx +62 -0
  33. package/template/src/main.tsx +14 -16
  34. package/template/tsconfig.app.json +24 -26
  35. package/template/vite-plugin-mdx-components.ts +169 -0
  36. package/template/vite.config.ts +17 -4
  37. package/template/public/docs/en/guide/quick-start.md +0 -108
  38. package/template/public/docs/en/guide.md +0 -10
  39. package/template/public/docs/zh-cn/guide.md +0 -10
  40. /package/template/public/docs/en/{guide → docs/guide}/introduction.md +0 -0
  41. /package/template/public/docs/zh-cn/{guide → docs/guide}/introduction.md +0 -0
package/template/public/config/site.yaml CHANGED
@@ -1,193 +1,206 @@
1
1
  # 网站基本配置
2
2
  site:
3
- title: "React Docs UI 示例项目"
4
- description: "基于 React Docs UI 构建的文档网站示例"
5
- # logo支持以下格式：
6
- # 1. emoji: "🤖"
7
- # 2. 图片URL: "https://example.com/logo.png"
8
- # 3. 本地图片: "/images/logo.png"
9
- # 4. 相对路径: "./assets/logo.svg"
10
- logo:
11
- light: "/images/favicon.svg"
12
- dark: "/images/favicon-dark.svg"
13
- author: "React Docs UI Team"
14
-
3
+ title: "React Docs UI 示例项目"
4
+ description: "基于 React Docs UI 构建的文档网站示例"
5
+ # logo支持以下格式：
6
+ # 1. emoji: "🤖"
7
+ # 2. 图片URL: "https://example.com/logo.png"
8
+ # 3. 本地图片: "/images/logo.png"
9
+ # 4. 相对路径: "./assets/logo.svg"
10
+ logo:
11
+ light: "/images/favicon.svg"
12
+ dark: "/images/favicon-dark.svg"
13
+ author: "React Docs UI Team"
14
+
15
15
  # 顶部导航配置
16
16
  navbar:
17
- showLogo: true
18
- showTitle: true
19
- showLanguageSwitcher: true
20
- items:
21
- - title: "首页"
22
- link: "/"
23
- active: true
24
- - title: "指南"
25
- link: "/guide"
26
- actions:
27
- - type: "github"
28
- link: "https://github.com/shenjianZ/React-docs-ui"
29
- enabled: true
17
+ showLogo: true
18
+ showTitle: true
19
+ showLanguageSwitcher: true
20
+ items:
21
+ - title: "首页"
22
+ link: "/"
23
+ active: true
24
+ - title: "文档"
25
+ link: "/docs"
26
+ actions:
27
+ - type: "github"
28
+ link: "https://github.com/shenjianZ/React-docs-ui"
29
+ enabled: true
30
30
 
31
31
  # 侧边栏导航配置
32
32
  sidebar:
33
- enabled: true
34
- collections:
35
- guide:
36
- sections:
37
- - title: "快速开始"
38
- path: "/guide"
39
- children:
40
- - title: "介绍"
41
- path: "/guide/introduction"
42
- - title: "安装"
43
- path: "/guide/installation"
44
- - title: "快速上手"
45
- path: "/guide/quick-start"
46
- - title: "配置说明"
47
- path: "/guide/configuration"
48
-
33
+ enabled: true
34
+ collections:
35
+ docs:
36
+ sections:
37
+ - title: "快速开始"
38
+ path: "/docs/guide"
39
+ children:
40
+ - title: "介绍"
41
+ path: "/docs/guide/introduction"
42
+ - title: "安装"
43
+ path: "/docs/guide/installation"
44
+ - title: "快速上手"
45
+ path: "/docs/guide/quick-start"
46
+ - title: "配置说明"
47
+ path: "/docs/guide/configuration"
48
+ - title: "文档测试"
49
+ path: "/docs/test"
50
+ children:
51
+ - title: "MD测试"
52
+ path: "/docs/test/test"
53
+ - title: "katex测试"
54
+ path: "/docs/test/katex-test"
55
+ - title: "MDX 演示"
56
+ path: "/docs/test/mdx-test"
49
57
 
50
58
  # Theme Configuration
51
59
  theme:
52
- # Default theme mode: 'light' | 'dark' | 'auto'
53
- # light: Force light mode
54
- # dark: Force dark mode
55
- # auto: Follow system preference (default)
56
- defaultMode: "auto"
57
-
58
- # Allow users to toggle theme (show theme toggle button)
59
- allowToggle: true
60
-
60
+ # Default theme mode: 'light' | 'dark' | 'auto'
61
+ # light: Force light mode
62
+ # dark: Force dark mode
63
+ # auto: Follow system preference (default)
64
+ defaultMode: "auto"
65
+
66
+ # Allow users to toggle theme (show theme toggle button)
67
+ allowToggle: true
61
68
 
62
69
  # Table of Contents Configuration
63
70
  toc:
64
- # Maximum heading level to display in TOC (1-6)
65
- maxLevel: 3
66
-
67
- # Enable table of contents
68
- enabled: true
69
-
70
- # TOC title
71
- title: "本页目录"
71
+ # Maximum heading level to display in TOC (1-6)
72
+ maxLevel: 3
73
+
74
+ # Enable table of contents
75
+ enabled: true
76
+
77
+ # TOC title
78
+ title: "本页目录"
72
79
 
73
80
  # Footer Configuration
74
81
  footer:
75
- enabled: true
76
- copyright: "© 2025 React Docs UI. All rights reserved."
77
- repository:
78
- url: "https://github.com/shenjianZ/React-docs-ui"
79
- branch: "master"
80
- lastUpdated: "2025-08-14"
81
- version: "v0.1.7"
82
- groups:
83
- - title: "社区"
84
- items:
85
- - title: "讨论区"
86
- link: "https://github.com/shenjianZ/React-docs-ui/discussions"
87
- external: true
88
- - title: "问题反馈"
89
- link: "https://github.com/shenjianZ/React-docs-ui/issues"
90
- external: true
91
- - title: "贡献指南"
92
- link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
93
- external: true
94
- - title: "版本发布"
95
- link: "https://github.com/shenjianZ/React-docs-ui/releases"
96
- external: true
97
- - title: "帮助支持"
98
- items:
99
- - title: "示例"
100
- link: "/guide/quick-start"
101
- - title: "源代码"
82
+ enabled: true
83
+ copyright: "© 2026 React Docs UI. All rights reserved."
84
+ repository:
85
+ url: "https://github.com/shenjianZ/React-docs-ui"
86
+ branch: "master"
87
+ lastUpdated: "2026-03-05"
88
+ version: "v0.4.0"
89
+ groups:
90
+ - title: "社区"
91
+ items:
92
+ - title: "讨论区"
93
+ link: "https://github.com/shenjianZ/React-docs-ui/discussions"
94
+ external: true
95
+ - title: "问题反馈"
96
+ link: "https://github.com/shenjianZ/React-docs-ui/issues"
97
+ external: true
98
+ - title: "贡献指南"
99
+ link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
100
+ external: true
101
+ - title: "版本发布"
102
+ link: "https://github.com/shenjianZ/React-docs-ui/releases"
103
+ external: true
104
+ - title: "帮助支持"
105
+ items:
106
+ - title: "快速开始"
107
+ link: "/docs/guide"
108
+ - title: "源代码"
109
+ link: "https://github.com/shenjianZ/React-docs-ui"
110
+ external: true
111
+ - title: "开源许可"
112
+ link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
113
+ external: true
114
+ - title: "回到顶部"
115
+ link: "#"
116
+ action: "scrollTop"
117
+ links:
118
+ - title: "Documentation"
119
+ link: "/guide/introduction"
120
+ - title: "GitHub"
102
121
  link: "https://github.com/shenjianZ/React-docs-ui"
103
122
  external: true
104
- - title: "开源许可"
105
- link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
106
- external: true
107
- - title: "回到顶部"
108
- link: "#"
109
- action: "scrollTop"
110
- links:
111
- - title: "Documentation"
112
- link: "/guide/introduction"
113
- - title: "GitHub"
114
- link: "https://github.com/shenjianZ/React-docs-ui"
115
- external: true
116
- - title: "License"
117
- link: "/license"
118
- social:
119
- - name: "email"
120
- url: "mailto:contact@example.com"
121
- icon: "mail"
122
- - name: "github"
123
- url: "https://github.com/your_github_id"
124
- icon: "github"
125
- # - name: "youtube"
126
- # url: "https://youtube.com/@yourhandle"
127
- # icon: "youtube"
128
- # - name: "twitter"
129
- # url: "https://twitter.com/yourhandle"
130
- # icon: "twitter"
131
- # - name: "discord"
132
- # url: "https://discord.gg/yourinvite"
133
- # icon: "discord"
134
- # - name: "telegram"
135
- # url: "https://t.me/yourhandle"
136
- # icon: "telegram"
137
- # - name: "tiktok"
138
- # url: "https://tiktok.com/@yourhandle"
139
- # icon: "tiktok"
140
- - name: "bilibili"
141
- url: "https://space.bilibili.com/your_bilibili_id"
142
- icon: "bilibili"
143
- - name: "qq"
144
- url: "mqqapi://card/show_pslcard?src_type=internal&version=1&uin=your_qq_id&card_type=person&source=qrcode"
145
- icon: "qq"
146
- - name: "wechat"
147
- url: "weixin://dl/add?your_wechat_id"
148
- icon: "wechat"
149
- # - name: "weibo"
150
- # url: "https://weibo.com/yourhandle"
151
- # icon: "weibo"
152
- # - name: "douyin"
153
- # url: "https://www.douyin.com/user/yourhandle"
154
- # icon: "douyin"
155
- # - name: "zhihu"
156
- # url: "https://www.zhihu.com/people/yourhandle"
157
- # icon: "zhihu"
123
+ - title: "License"
124
+ link: "/license"
125
+ social:
126
+ - name: "email"
127
+ url: "mailto:contact@example.com"
128
+ icon: "mail"
129
+ - name: "github"
130
+ url: "https://github.com/your_github_id"
131
+ icon: "github"
132
+ # - name: "youtube"
133
+ # url: "https://youtube.com/@yourhandle"
134
+ # icon: "youtube"
135
+ # - name: "twitter"
136
+ # url: "https://twitter.com/yourhandle"
137
+ # icon: "twitter"
138
+ # - name: "discord"
139
+ # url: "https://discord.gg/yourinvite"
140
+ # icon: "discord"
141
+ # - name: "telegram"
142
+ # url: "https://t.me/yourhandle"
143
+ # icon: "telegram"
144
+ # - name: "tiktok"
145
+ # url: "https://tiktok.com/@yourhandle"
146
+ # icon: "tiktok"
147
+ - name: "bilibili"
148
+ url: "https://space.bilibili.com/your_bilibili_id"
149
+ icon: "bilibili"
150
+ - name: "qq"
151
+ url: "mqqapi://card/show_pslcard?src_type=internal&version=1&uin=your_qq_id&card_type=person&source=qrcode"
152
+ icon: "qq"
153
+ - name: "wechat"
154
+ url: "weixin://dl/add?your_wechat_id"
155
+ icon: "wechat"
156
+ # - name: "weibo"
157
+ # url: "https://weibo.com/yourhandle"
158
+ # icon: "weibo"
159
+ # - name: "douyin"
160
+ # url: "https://www.douyin.com/user/yourhandle"
161
+ # icon: "douyin"
162
+ # - name: "zhihu"
163
+ # url: "https://www.zhihu.com/people/yourhandle"
164
+ # icon: "zhihu"
158
165
 
159
166
  # PWA Configuration
160
167
  pwa:
161
- enabled: true
162
- name: "React Docs UI"
163
- shortName: "ReactDocsUI"
164
- description: "Beautiful documentation websites made simple"
165
- themeColor: "#ffffff"
166
- backgroundColor: "#ffffff"
168
+ enabled: true
169
+ name: "React Docs UI"
170
+ shortName: "ReactDocsUI"
171
+ description: "Beautiful documentation websites made simple"
172
+ themeColor: "#ffffff"
173
+ backgroundColor: "#ffffff"
167
174
 
168
175
  # 右键菜单配置
169
176
  contextMenu:
170
- # 全局开关，false 则完全禁用右键菜单
171
- enabled: true
177
+ # 全局开关，false 则完全禁用右键菜单
178
+ enabled: true
179
+
180
+ # 页面组菜单项配置
181
+ page:
182
+ copySelectedText: true # 复制选中的文字
183
+ copyUrl: true # 复制当前链接
184
+ copyTitle: false # 复制页面标题
185
+ copyMarkdownLink: false # 复制 Markdown 链接
186
+ openInNewTab: false # 在新标签页打开
187
+ reload: true # 刷新
188
+ printPage: true # 打印页面
189
+ scrollToTop: true # 回到顶部
190
+ scrollToBottom: true # 滚动到底部
172
191
 
173
- # 页面组菜单项配置
174
- page:
175
- copyUrl: true # 复制当前链接
176
- copyTitle: false # 复制页面标题
177
- copyMarkdownLink: true # 复制 Markdown 链接
178
- openInNewTab: false # 在新标签页打开
179
- reload: true # 刷新
180
- printPage: true # 打印页面
181
- scrollToTop: true # 回到顶部
182
- scrollToBottom: true # 滚动到底部
192
+ # 站点组菜单项配置
193
+ site:
194
+ goHome: true # 返回首页
195
+ quickNav: false # 快速跳转
196
+ language: false # 语言切换
183
197
 
184
- # 站点组菜单项配置
185
- site:
186
- goHome: true # 返回首页
187
- quickNav: false # 快速跳转
188
- language: false # 语言切换
198
+ # 外观组菜单项配置
199
+ appearance:
200
+ theme: false # 主题切换
201
+ resetThemePref: false # 重置主题偏好
189
202
 
190
- # 外观组菜单项配置
191
- appearance:
192
- theme: false # 主题切换
193
- resetThemePref: false # 重置主题偏好
203
+ # MDX 组件配置
204
+ mdx:
205
+ componentsPath: "/src/components" # 组件扫描路径
206
+ enabled: true # 启用 MDX 支持