create-react-docs-ui 0.1.4 → 0.1.6

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/README.md

@@ -1,82 +1,85 @@
-# create-react-docs-ui
-
-A simple scaffolding tool to quickly set up a modern documentation website powered by [react-docs-ui](https://github.com/btea/react-docs-ui).
-
-This tool creates a new project with a pre-configured, feature-rich documentation site, allowing you to focus solely on writing your Markdown content.
-
-## About the underlying library: react-docs-ui
-
-`react-docs-ui` is a React component library and toolset designed specifically for building documentation websites. Its core philosophy is **configuration over code**.
-
-### Core Features
-
-- **Configuration-Driven**: No need to write complex React components or routing logic. Define your entire site—navigation, sidebar, themes, and footer—through a simple `site.yaml` file.
-- **Fully-Featured Out-of-the-Box**:
-  - Responsive, modern design.
-  - Light/dark theme switching.
-  - Markdown rendering (GFM and Frontmatter supported).
-  - Built-in syntax highlighting.
-  - Quick command menu (`Cmd+K`).
-  - Internationalization (i18n) support.
-- **Extremely Simple to Start**: Launch a complete documentation site in under a minute.
-- **Highly Customizable**: Easily customize the logo, color scheme, navigation links, social media icons, and more.
-
-## Getting Started
-
-### Prerequisites
-
-- **Node.js**: Version `>= 18.0.0`
-- **Package Manager**: `npm`, `yarn`, or `pnpm`
-
-### Creating a New Project
-
-Run one of the following commands to create your new documentation site. Replace `my-docs` with your desired project name.
-
-#### 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
-```
-
-### Running Your Site
-
-After the project is created, navigate into the new directory, install dependencies, and start the development server.
-
-```bash
-cd my-docs
-npm install
-npm run dev
-```
-
-Your new documentation website will be running at `http://localhost:5173`.
-
-## Project Structure
-
-The generated project has a straightforward structure:
-
-- **`public/config/site.yaml`**: The central configuration file for your entire site. This is where you'll define navigation, sidebars, and metadata.
-- **`public/docs/`**: The directory where all your Markdown documentation files reside. It's pre-configured with `en` and `zh-cn` subdirectories for internationalization.
-- **`src/`**: Contains the main application entry point. You typically won't need to modify files here.
-
-## Basic Configuration
-
-To customize your site, you'll primarily edit `public/config/site.yaml`. Here you can:
-
-- **Change the site title and logo**: Modify the `site` object.
-- **Add navigation links**: Add items to the `navbar.items` array.
-- **Structure your documentation**: Define the hierarchy of your content in the `sidebar.collections` object.
-
-For a complete guide on all available options, please refer to the documentation within your newly created project.
-
-## License
-
-This project is licensed under the [MIT License](LICENSE).
+English | [简体中文](README-zh.md)
+
+## create-react-docs-ui
+
+Scaffold a React documentation site in seconds, powered by [`react-docs-ui`](https://github.com/shenjianZ/react-docs-ui). Focus on writing Markdown; routing, theming, MDX, syntax highlighting, i18n, sidebar/TOC and a command menu are prewired.
+
+### Features
+- Configuration over code via `public/config/site.yaml`
+- MD/MDX rendering, syntax highlight, GFM, simple frontmatter parsing
+- Light/dark theme and command palette (Cmd/Ctrl+K)
+- Built-in i18n folders (e.g. `en`, `zh-cn`)
+- Ready-to-run Vite setup
+
+### Requirements
+- Node.js >= 18
+
+### Quick start
+- 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
+```
+Then:
+```bash
+cd my-docs
+npm install
+npm run dev
+```
+Dev server runs at http://localhost:5173
+
+### Scripts (generated project)
+- `dev`: start Vite dev server
+- `build`: type-check and build
+- `preview`: preview production build
+
+### Project structure (generated)
+- `public/config/site.yaml` and `public/config/site.en.yaml`: site config per language
+- `public/docs/<lang>/**/*.md`: Markdown docs, matched by route slug
+- `src/`: app entry; usually no changes required
+
+### Config example (`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: Getting Started
+          path: guide
+          children:
+            - { title: Introduction, path: guide/introduction }
+```
+
+### Docs example (`public/docs/en/guide/introduction.md`)
+```markdown
+---
+title: Introduction
+---
+
+# Introduction
+
+Welcome to My Docs!
+```
+
+### Links
+- Underlying UI library: `react-docs-ui` — https://github.com/shenjianZ/react-docs-ui
+
+### License
+[MIT](LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-docs-ui",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "private": false,
   "type": "module",
   "bin": {
@@ -17,9 +17,23 @@
     "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",
+  "keywords": [
+    "react",
+    "cli",
+    "scaffolding",
+    "starter",
+    "template",
+    "docs",
+    "documentation",
+    "mdx",
+    "boilerplate",
+    "create-tool"
   ],
-  "description": "Scaffold a React Docs UI project powered by react-docs-ui",
   "license": "MIT"
 }
 

package/template/index.html

@@ -2,13 +2,14 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/images/favicon.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>React Docs UI</title>
+    <title>Docs</title>
   </head>
   <body>
     <div id="root"></div>
     <script type="module" src="/src/main.tsx"></script>
   </body>
-  </html>
+</html>
 
 

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

@@ -1,7 +1,7 @@
 # Website Configuration
 site:
-  title: "Vue Docs UI Example"
-  description: "Example documentation website built with Vue Docs UI"
+  title: "React Docs UI Example"
+  description: "Example documentation website built with React Docs UI"
   # Logo formats supported:
   # 1. emoji: "🤖"
   # 2. image URL: "https://example.com/logo.png"
@@ -10,7 +10,7 @@ site:
   logo:
     light: "/images/favicon.svg"
     dark: "/images/favicon-dark.svg"
-  author: "Vue Docs UI Team"
+  author: "React Docs UI Team"
   
 # Navigation Bar Configuration
 navbar:
@@ -25,7 +25,7 @@ navbar:
       link: "/guide"
   actions:
     - type: "github"
-      link: "https://github.com/shenjianZ/vue-docs-ui"
+      link: "https://github.com/shenjianZ/React-docs-ui"
       enabled: true
 
 # Sidebar Navigation Configuration
@@ -73,7 +73,7 @@ toc:
 # Footer Configuration
 footer:
   enabled: true
-  copyright: "© 2024 Vue Docs UI. All rights reserved."
+  copyright: "© 2024 React Docs UI. All rights reserved."
   repository:
     url: "https://github.com/your_github_id/your_repo_name"
     branch: "master"
@@ -130,8 +130,8 @@ footer:
 # PWA Configuration
 pwa:
   enabled: false
-  name: "Vue Docs UI"
-  shortName: "VueDocsUI"
+  name: "React Docs UI"
+  shortName: "ReactDocsUI"
   description: "Beautiful documentation websites made simple"
   themeColor: "#ffffff"
   backgroundColor: "#ffffff" 

package/template/public/config/site.yaml

@@ -1,7 +1,7 @@
 # 网站基本配置
 site:
-  title: "Vue Docs UI 示例项目"
-  description: "基于 Vue Docs UI 构建的文档网站示例"
+  title: "React Docs UI 示例项目"
+  description: "基于 React Docs UI 构建的文档网站示例"
   # logo支持以下格式：
   # 1. emoji: "🤖"
   # 2. 图片URL: "https://example.com/logo.png"
@@ -10,7 +10,7 @@ site:
   logo:
     light: "/images/favicon.svg"
     dark: "/images/favicon-dark.svg"
-  author: "Vue Docs UI Team"
+  author: "React Docs UI Team"
   
 # 顶部导航配置
 navbar:
@@ -25,7 +25,7 @@ navbar:
       link: "/guide"
   actions:
     - type: "github"
-      link: "https://github.com/shenjianZ/vue-docs-ui"
+      link: "https://github.com/shenjianZ/React-docs-ui"
       enabled: true
 
 # 侧边栏导航配置
@@ -73,7 +73,7 @@ toc:
 # Footer Configuration
 footer:
   enabled: true
-  copyright: "© 2024 Vue Docs UI. All rights reserved."
+  copyright: "© 2024 React Docs UI. All rights reserved."
   repository:
     url: "https://github.com/your_github_id/your_repo_name"
     branch: "master"
@@ -130,8 +130,8 @@ footer:
 # PWA Configuration
 pwa:
   enabled: true
-  name: "Vue Docs UI"
-  shortName: "VueDocsUI"
+  name: "React Docs UI"
+  shortName: "ReactDocsUI"
   description: "Beautiful documentation websites made simple"
   themeColor: "#ffffff"
   backgroundColor: "#ffffff"