create-react-docs-ui 0.3.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 (39) hide show
  1. package/README-zh.md +33 -85
  2. package/README.md +33 -85
  3. package/package.json +44 -42
  4. package/template/package.json +3 -3
  5. package/template/public/config/site.en.yaml +177 -155
  6. package/template/public/config/site.yaml +28 -13
  7. package/template/public/docs/en/{guide → docs/guide}/configuration.md +195 -149
  8. package/template/public/docs/en/{guide → docs/guide}/installation.md +2 -2
  9. package/template/public/docs/en/docs/guide/quick-start.md +96 -0
  10. package/template/public/docs/en/docs/guide.md +10 -0
  11. package/template/public/docs/en/docs/test/katex-test.md +258 -0
  12. package/template/public/docs/en/docs/test/mdx-test.mdx +136 -0
  13. package/template/public/docs/en/docs/test/test.md +212 -0
  14. package/template/public/docs/en/docs/test.md +9 -0
  15. package/template/public/docs/en/docs.md +16 -0
  16. package/template/public/docs/zh-cn/{guide → docs/guide}/configuration.md +196 -150
  17. package/template/public/docs/zh-cn/{guide → docs/guide}/installation.md +2 -2
  18. package/template/public/docs/zh-cn/{guide → docs/guide}/quick-start.md +13 -25
  19. package/template/public/docs/zh-cn/docs/guide.md +10 -0
  20. package/template/public/docs/zh-cn/docs/test/katex-test.md +260 -0
  21. package/template/public/docs/zh-cn/docs/test/mdx-test.mdx +139 -0
  22. package/template/public/docs/zh-cn/docs/test/test.md +215 -0
  23. package/template/public/docs/zh-cn/docs/test.md +9 -0
  24. package/template/public/docs/zh-cn/docs.md +16 -0
  25. package/template/public/images/yrzx.png +0 -0
  26. package/template/src/components/Alert.tsx +30 -0
  27. package/template/src/components/BadgeList.tsx +38 -0
  28. package/template/src/components/Callout.tsx +20 -0
  29. package/template/src/components/Feature.tsx +15 -0
  30. package/template/src/components/MyTip.tsx +19 -0
  31. package/template/src/components/StepList.tsx +62 -0
  32. package/template/tsconfig.app.json +24 -26
  33. package/template/vite-plugin-mdx-components.ts +169 -0
  34. package/template/vite.config.ts +13 -4
  35. package/template/public/docs/en/guide/quick-start.md +0 -108
  36. package/template/public/docs/en/guide.md +0 -10
  37. package/template/public/docs/zh-cn/guide.md +0 -10
  38. /package/template/public/docs/en/{guide → docs/guide}/introduction.md +0 -0
  39. /package/template/public/docs/zh-cn/{guide → docs/guide}/introduction.md +0 -0
package/template/public/config/site.en.yaml CHANGED
@@ -1,185 +1,207 @@
1
1
  # Website Configuration
2
2
  site:
3
- title: "React Docs UI Example"
4
- description: "Example documentation website built with React Docs UI"
5
- # Logo formats supported:
6
- # 1. emoji: "🤖"
7
- # 2. image URL: "https://example.com/logo.png"
8
- # 3. local image: "/images/logo.png"
9
- # 4. relative path: "./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 Example"
4
+ description: "Example documentation website built with React Docs UI"
5
+ # Logo formats supported:
6
+ # 1. emoji: "🤖"
7
+ # 2. image URL: "https://example.com/logo.png"
8
+ # 3. local image: "/images/logo.png"
9
+ # 4. relative path: "./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
  # Navigation Bar Configuration
16
16
  navbar:
17
- showLogo: true
18
- showTitle: true
19
- showLanguageSwitcher: true
20
- items:
21
- - title: "Home"
22
- link: "/"
23
- active: true
24
- - title: "Guide"
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: "Home"
22
+ link: "/"
23
+ active: true
24
+ - title: "Document"
25
+ link: "/docs"
26
+ actions:
27
+ - type: "github"
28
+ link: "https://github.com/shenjianZ/React-docs-ui"
29
+ enabled: true
30
30
 
31
31
  # Sidebar Navigation Configuration
32
32
  sidebar:
33
- enabled: true
34
- collections:
35
- guide:
36
- sections:
37
- - title: "Getting Started"
38
- path: "/guide"
39
- children:
40
- - title: "Introduction"
41
- path: "/guide/introduction"
42
- - title: "Installation"
43
- path: "/guide/installation"
44
- - title: "Quick Start"
45
- path: "/guide/quick-start"
46
- - title: "Configuration"
47
- path: "/guide/configuration"
48
-
33
+ enabled: true
34
+ collections:
35
+ docs:
36
+ sections:
37
+ - title: "Getting Started"
38
+ path: "/docs/guide"
39
+ children:
40
+ - title: "Introduction"
41
+ path: "/docs/guide/introduction"
42
+ - title: "Installation"
43
+ path: "/docs/guide/installation"
44
+ - title: "Quick Start"
45
+ path: "/docs/guide/quick-start"
46
+ - title: "Configuration"
47
+ path: "/docs/guide/configuration"
48
+ - title: "Documentation Tests"
49
+ path: "/docs/test"
50
+ children:
51
+ - title: "MD Test"
52
+ path: "/docs/test/test"
53
+ - title: "KaTeX Test"
54
+ path: "/docs/test/katex-test"
55
+ - title: "MDX Demo"
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: "On This Page"
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: "On This Page"
72
79
 
73
80
  # Footer Configuration
74
81
  footer:
75
- enabled: true
76
- copyright: "© 2024 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: "Community"
84
- items:
85
- - title: "Discussions"
86
- link: "https://github.com/shenjianZ/React-docs-ui/discussions"
87
- external: true
88
- - title: "Issues"
89
- link: "https://github.com/shenjianZ/React-docs-ui/issues"
90
- external: true
91
- - title: "Contributing"
92
- link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
93
- external: true
94
- - title: "Releases"
95
- link: "https://github.com/shenjianZ/React-docs-ui/releases"
96
- external: true
97
- - title: "Help & Support"
98
- items:
99
- - title: "Examples"
100
- link: "/guide/quick-start"
101
- - title: "Source Code"
82
+ enabled: true
83
+ copyright: "© 2025 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: "Community"
91
+ items:
92
+ - title: "Discussions"
93
+ link: "https://github.com/shenjianZ/React-docs-ui/discussions"
94
+ external: true
95
+ - title: "Issues"
96
+ link: "https://github.com/shenjianZ/React-docs-ui/issues"
97
+ external: true
98
+ - title: "Contributing"
99
+ link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
100
+ external: true
101
+ - title: "Releases"
102
+ link: "https://github.com/shenjianZ/React-docs-ui/releases"
103
+ external: true
104
+ - title: "Help & Support"
105
+ items:
106
+ - title: "quick-start"
107
+ link: "/docs/guide"
108
+ - title: "Source Code"
109
+ link: "https://github.com/shenjianZ/React-docs-ui"
110
+ external: true
111
+ - title: "License"
112
+ link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
113
+ external: true
114
+ - title: "Back to Top"
115
+ link: "#"
116
+ action: "scrollTop"
117
+ links:
118
+ - title: "Documentation"
119
+ link: "/docs/guide/introduction"
120
+ - title: "GitHub"
102
121
  link: "https://github.com/shenjianZ/React-docs-ui"
103
122
  external: true
104
123
  - title: "License"
105
124
  link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
106
125
  external: true
107
- - title: "Back to Top"
108
- link: "#"
109
- action: "scrollTop"
110
- social:
111
- - name: "email"
112
- url: "mailto:contact@example.com"
113
- icon: "mail"
114
- - name: "github"
115
- link: "https://github.com/shenjianZ/React-docs-ui"
116
- icon: "github"
117
- # - name: "youtube"
118
- # url: "https://youtube.com/@yourhandle"
119
- # icon: "youtube"
120
- # - name: "twitter"
121
- # url: "https://twitter.com/yourhandle"
122
- # icon: "twitter"
123
- # - name: "discord"
124
- # url: "https://discord.gg/yourinvite"
125
- # icon: "discord"
126
- # - name: "telegram"
127
- # url: "https://t.me/yourhandle"
128
- # icon: "telegram"
129
- # - name: "tiktok"
130
- # url: "https://tiktok.com/@yourhandle"
131
- # icon: "tiktok"
132
- - name: "bilibili"
133
- url: "https://space.bilibili.com/your_bilibili_id"
134
- icon: "bilibili"
135
- - name: "qq"
136
- url: "mqqapi://card/show_pslcard?src_type=internal&version=1&uin=your_qq_id&card_type=person&source=qrcode"
137
- icon: "qq"
138
- - name: "wechat"
139
- url: "weixin://dl/add?your_wechat_id"
140
- icon: "wechat"
141
- # - name: "weibo"
142
- # url: "https://weibo.com/yourhandle"
143
- # icon: "weibo"
144
- # - name: "douyin"
145
- # url: "https://www.douyin.com/user/yourhandle"
146
- # icon: "douyin"
147
- # - name: "zhihu"
148
- # url: "https://www.zhihu.com/people/yourhandle"
149
- # icon: "zhihu"
126
+ social:
127
+ - name: "email"
128
+ url: "mailto:contact@example.com"
129
+ icon: "mail"
130
+ - name: "github"
131
+ link: "https://github.com/shenjianZ/React-docs-ui"
132
+ icon: "github"
133
+ # - name: "youtube"
134
+ # url: "https://youtube.com/@yourhandle"
135
+ # icon: "youtube"
136
+ # - name: "twitter"
137
+ # url: "https://twitter.com/yourhandle"
138
+ # icon: "twitter"
139
+ # - name: "discord"
140
+ # url: "https://discord.gg/yourinvite"
141
+ # icon: "discord"
142
+ # - name: "telegram"
143
+ # url: "https://t.me/yourhandle"
144
+ # icon: "telegram"
145
+ # - name: "tiktok"
146
+ # url: "https://tiktok.com/@yourhandle"
147
+ # icon: "tiktok"
148
+ - name: "bilibili"
149
+ url: "https://space.bilibili.com/your_bilibili_id"
150
+ icon: "bilibili"
151
+ - name: "qq"
152
+ url: "mqqapi://card/show_pslcard?src_type=internal&version=1&uin=your_qq_id&card_type=person&source=qrcode"
153
+ icon: "qq"
154
+ - name: "wechat"
155
+ url: "weixin://dl/add?your_wechat_id"
156
+ icon: "wechat"
157
+ # - name: "weibo"
158
+ # url: "https://weibo.com/yourhandle"
159
+ # icon: "weibo"
160
+ # - name: "douyin"
161
+ # url: "https://www.douyin.com/user/yourhandle"
162
+ # icon: "douyin"
163
+ # - name: "zhihu"
164
+ # url: "https://www.zhihu.com/people/yourhandle"
165
+ # icon: "zhihu"
150
166
 
151
167
  # PWA Configuration
152
168
  pwa:
153
- enabled: false
154
- name: "React Docs UI"
155
- shortName: "ReactDocsUI"
156
- description: "Beautiful documentation websites made simple"
157
- themeColor: "#ffffff"
158
- backgroundColor: "#ffffff"
169
+ enabled: true
170
+ name: "React Docs UI"
171
+ shortName: "ReactDocsUI"
172
+ description: "Beautiful documentation websites made simple"
173
+ themeColor: "#ffffff"
174
+ backgroundColor: "#ffffff"
159
175
 
160
176
  # Context Menu Configuration
161
177
  contextMenu:
162
- # Global switch, set to false to completely disable context menu
163
- enabled: true
178
+ # Global switch, set to false to completely disable context menu
179
+ enabled: true
180
+
181
+ # Page group menu items configuration
182
+ page:
183
+ copySelectedText: true # Copy selected text
184
+ copyUrl: true # Copy current URL
185
+ copyTitle: false # Copy page title
186
+ copyMarkdownLink: false # Copy Markdown link
187
+ openInNewTab: false # Open in new tab
188
+ reload: true # Refresh
189
+ printPage: true # Print page
190
+ scrollToTop: true # Scroll to top
191
+ scrollToBottom: true # Scroll to bottom
164
192
 
165
- # Page group menu items configuration
166
- page:
167
- copyUrl: true # Copy current URL
168
- copyTitle: false # Copy page title
169
- copyMarkdownLink: true # Copy Markdown link
170
- openInNewTab: false # Open in new tab
171
- reload: true # Refresh
172
- printPage: true # Print page
173
- scrollToTop: true # Scroll to top
174
- scrollToBottom: true # Scroll to bottom
193
+ # Site group menu items configuration
194
+ site:
195
+ goHome: true # Go to home
196
+ quickNav: false # Quick navigation
197
+ language: false # Language switch
175
198
 
176
- # Site group menu items configuration
177
- site:
178
- goHome: true # Go to home
179
- quickNav: false # Quick navigation
180
- language: false # Language switch
199
+ # Appearance group menu items configuration
200
+ appearance:
201
+ theme: false # Theme switch
202
+ resetThemePref: false # Reset theme preference
181
203
 
182
- # Appearance group menu items configuration
183
- appearance:
184
- theme: false # Theme switch
185
- resetThemePref: false # Reset theme preference
204
+ # MDX Component Configuration
205
+ mdx:
206
+ componentsPath: "/src/components" # Component scan path
207
+ enabled: true # Enable MDX support
package/template/public/config/site.yaml CHANGED
@@ -21,8 +21,8 @@ navbar:
21
21
  - title: "首页"
22
22
  link: "/"
23
23
  active: true
24
- - title: "指南"
25
- link: "/guide"
24
+ - title: "文档"
25
+ link: "/docs"
26
26
  actions:
27
27
  - type: "github"
28
28
  link: "https://github.com/shenjianZ/React-docs-ui"
@@ -32,19 +32,28 @@ navbar:
32
32
  sidebar:
33
33
  enabled: true
34
34
  collections:
35
- guide:
35
+ docs:
36
36
  sections:
37
37
  - title: "快速开始"
38
- path: "/guide"
38
+ path: "/docs/guide"
39
39
  children:
40
40
  - title: "介绍"
41
- path: "/guide/introduction"
41
+ path: "/docs/guide/introduction"
42
42
  - title: "安装"
43
- path: "/guide/installation"
43
+ path: "/docs/guide/installation"
44
44
  - title: "快速上手"
45
- path: "/guide/quick-start"
45
+ path: "/docs/guide/quick-start"
46
46
  - title: "配置说明"
47
- path: "/guide/configuration"
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"
48
57
 
49
58
  # Theme Configuration
50
59
  theme:
@@ -71,12 +80,12 @@ toc:
71
80
  # Footer Configuration
72
81
  footer:
73
82
  enabled: true
74
- copyright: "© 2025 React Docs UI. All rights reserved."
83
+ copyright: "© 2026 React Docs UI. All rights reserved."
75
84
  repository:
76
85
  url: "https://github.com/shenjianZ/React-docs-ui"
77
86
  branch: "master"
78
- lastUpdated: "2025-08-14"
79
- version: "v0.1.7"
87
+ lastUpdated: "2026-03-05"
88
+ version: "v0.4.0"
80
89
  groups:
81
90
  - title: "社区"
82
91
  items:
@@ -94,8 +103,8 @@ footer:
94
103
  external: true
95
104
  - title: "帮助支持"
96
105
  items:
97
- - title: "示例"
98
- link: "/guide/quick-start"
106
+ - title: "快速开始"
107
+ link: "/docs/guide"
99
108
  - title: "源代码"
100
109
  link: "https://github.com/shenjianZ/React-docs-ui"
101
110
  external: true
@@ -170,6 +179,7 @@ contextMenu:
170
179
 
171
180
  # 页面组菜单项配置
172
181
  page:
182
+ copySelectedText: true # 复制选中的文字
173
183
  copyUrl: true # 复制当前链接
174
184
  copyTitle: false # 复制页面标题
175
185
  copyMarkdownLink: false # 复制 Markdown 链接
@@ -189,3 +199,8 @@ contextMenu:
189
199
  appearance:
190
200
  theme: false # 主题切换
191
201
  resetThemePref: false # 重置主题偏好
202
+
203
+ # MDX 组件配置
204
+ mdx:
205
+ componentsPath: "/src/components" # 组件扫描路径
206
+ enabled: true # 启用 MDX 支持