create-react-docs-ui 0.1.5 → 0.1.7

package/README-zh.md

@@ -0,0 +1,85 @@
+简体中文 | [English](README.md)
+
+## create-react-docs-ui
+
+秒级搭建 React 文档站，基于 [`react-docs-ui`](https://github.com/shenjianZ/react-docs-ui)。专注写 Markdown，路由、主题、MDX、代码高亮、国际化、侧边栏/目录与命令面板均已预置。
+
+### 特性
+- 以配置为中心：`public/config/site.yaml`
+- 支持 MD/MDX、语法高亮、GFM、简易 Frontmatter 解析
+- 亮/暗主题切换与命令面板（Cmd/Ctrl+K）
+- 预置多语言目录（如 `en`、`zh-cn`）
+- Vite 开箱可用
+
+### 环境要求
+- Node.js >= 18
+
+### 快速开始
+- npm:
+```bash
+npm create react-docs-ui@latest my-docs
+```
+- yarn:
+```bash
+yarn create react-docs-ui my-docs
+```
+- pnpm:
+```bash
+pnpm create react-docs-ui my-docs
+```
+然后：
+```bash
+cd my-docs
+npm install
+npm run dev
+```
+开发地址：http://localhost:5173
+
+### 生成项目脚本
+- `dev`: 启动 Vite 开发服务器
+- `build`: 类型检查并构建
+- `preview`: 预览产物
+
+### 生成项目结构
+- `public/config/site.yaml`、`public/config/site.en.yaml`：按语言的站点配置
+- `public/docs/<lang>/**/*.md`：文档 Markdown，路径映射路由
+- `src/`：应用入口，一般无需修改
+
+### 配置示例（`public/config/site.yaml`）
+```yaml
+site:
+  logo: /logo.svg
+  title: My Docs
+  description: Awesome docs
+navbar:
+  showTitle: true
+  items:
+    - title: GitHub
+      link: https://github.com/shenjianZ/react-docs-ui
+      external: true
+sidebar:
+  collections:
+    guide:
+      sections:
+        - title: 入门
+          path: guide
+          children:
+            - { title: 介绍, path: guide/introduction }
+```
+
+### 文档示例（`public/docs/en/guide/introduction.md`）
+```markdown
+---
+title: Introduction
+---
+
+# Introduction
+
+Welcome to My Docs!
+```
+
+### 相关链接
+- 底层 UI 库：`react-docs-ui` — https://github.com/shenjianZ/react-docs-ui
+
+### 许可证
+[MIT](LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-docs-ui",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "private": false,
   "type": "module",
   "bin": {
@@ -17,7 +17,8 @@
     "template/tsconfig.app.json",
     "template/tsconfig.json",
     "template/vite.config.ts",
-    "README.md"
+    "README.md",
+    "README-zh.md"
   ],
   "description": "Scaffold a React documentation site with one command — built-in routing, theming, MDX, examples, and production-ready build config, powered by react-docs-ui.",
   "homepage": "https://github.com/shenjianZ/create-react-docs-ui",

package/template/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "buffer": "^6.0.3",
     "react": ">=18",
-    "react-docs-ui": "^0.1.3",
+    "react-docs-ui": "^0.1.7",
     "react-dom": ">=18",
     "react-router-dom": "^7.8.0"
   },

package/template/public/config/site.en.yaml

@@ -75,23 +75,44 @@ footer:
   enabled: true
   copyright: "© 2024 React Docs UI. All rights reserved."
   repository:
-    url: "https://github.com/your_github_id/your_repo_name"
+    url: "https://github.com/shenjianZ/React-docs-ui"
     branch: "master"
-  lastUpdated: "2024-12-19"
-  links:
-    - title: "Documentation"
-      link: "/guide/introduction"
-    - title: "GitHub"
-      link: "https://github.com/your_github_id/your_repo_name"
-      external: true
-    - title: "License"
-      link: "/license"
+  lastUpdated: "2025-08-14"
+  version: "v0.1.7"
+  groups:
+    - title: "Community"
+      items:
+        - title: "Discussions"
+          link: "https://github.com/shenjianZ/React-docs-ui/discussions"
+          external: true
+        - title: "Issues"
+          link: "https://github.com/shenjianZ/React-docs-ui/issues"
+          external: true
+        - title: "Contributing"
+          link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
+          external: true
+        - title: "Releases"
+          link: "https://github.com/shenjianZ/React-docs-ui/releases"
+          external: true
+    - title: "Help & Support"
+      items:
+        - title: "Examples"
+          link: "/guide/quick-start"
+        - title: "Source Code"
+          link: "https://github.com/shenjianZ/React-docs-ui"
+          external: true
+        - title: "License"
+          link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
+          external: true
+        - title: "Back to Top"
+          link: "#"
+          action: "scrollTop"
   social:
     - name: "email"
       url: "mailto:contact@example.com"
       icon: "mail"
     - name: "github"
-      url: "https://github.com/your_github_id"
+      link: "https://github.com/shenjianZ/React-docs-ui"
       icon: "github"
     # - name: "youtube"
     #   url: "https://youtube.com/@yourhandle"

package/template/public/config/site.yaml

@@ -73,16 +73,45 @@ toc:
 # Footer Configuration
 footer:
   enabled: true
-  copyright: "© 2024 React Docs UI. All rights reserved."
+  copyright: "© 2025 React Docs UI. All rights reserved."
   repository:
-    url: "https://github.com/your_github_id/your_repo_name"
+    url: "https://github.com/shenjianZ/React-docs-ui"
     branch: "master"
-  lastUpdated: "2024-12-19"
+  lastUpdated: "2025-08-14"
+  version: "v0.1.7"
+  groups:
+    - title: "社区"
+      items:
+        - title: "讨论区"
+          link: "https://github.com/shenjianZ/React-docs-ui/discussions"
+          external: true
+        - title: "问题反馈"
+          link: "https://github.com/shenjianZ/React-docs-ui/issues"
+          external: true
+        - title: "贡献指南"
+          link: "https://github.com/shenjianZ/React-docs-ui/blob/master/CONTRIBUTING.md"
+          external: true
+        - title: "版本发布"
+          link: "https://github.com/shenjianZ/React-docs-ui/releases"
+          external: true
+    - title: "帮助支持"
+      items:
+        - title: "示例"
+          link: "/guide/quick-start"
+        - title: "源代码"
+          link: "https://github.com/shenjianZ/React-docs-ui"
+          external: true
+        - title: "开源许可"
+          link: "https://github.com/shenjianZ/React-docs-ui/blob/master/LICENSE"
+          external: true
+        - title: "回到顶部"
+          link: "#"
+          action: "scrollTop"
   links:
     - title: "Documentation"
       link: "/guide/introduction"
     - title: "GitHub"
-      link: "https://github.com/your_github_id/your_repo_name"
+      link: "https://github.com/shenjianZ/React-docs-ui"
       external: true
     - title: "License"
       link: "/license"