create-react-docs-ui 0.2.0 → 0.4.0

package/README-zh.md

@@ -1,85 +1,33 @@
-简体中文 | [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)
+简体中文 | [English](README.md)
+
+## create-react-docs-ui
+
+秒级搭建 React 文档站，基于 [`react-docs-ui`](https://github.com/shenjianZ/react-docs-ui)。
+
+### 特性
+
+- 配置驱动，通过 `site.yaml` 控制
+- MD/MDX 支持，代码语法高亮
+- 明暗主题切换
+- 命令菜单（Cmd+K）
+- 右键菜单
+- 国际化支持
+- Vite 开箱可用
+
+### 快速开始
+
+```bash
+npm create react-docs-ui@latest my-docs
+cd my-docs
+npm install && npm run dev
+```
+
+### 项目结构
+
+- `public/config/site.yaml` - 网站配置
+- `public/docs/<lang>/**/*.md` - 文档文件
+- `src/` - 应用入口
+
+### 许可证
+
+MIT

package/README.md

@@ -1,85 +1,33 @@
-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)
+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).
+
+### Features
+
+- Configuration-driven via `site.yaml`
+- MD/MDX with syntax highlighting
+- Light/dark themes
+- Command menu (Cmd+K)
+- Context menu
+- Internationalization
+- Vite setup
+
+### Quick Start
+
+```bash
+npm create react-docs-ui@latest my-docs
+cd my-docs
+npm install && npm run dev
+```
+
+### Project Structure
+
+- `public/config/site.yaml` - Site configuration
+- `public/docs/<lang>/**/*.md` - Documentation files
+- `src/` - App entry
+
+### License
+
+MIT

package/package.json

@@ -1,42 +1,44 @@
-{
-  "name": "create-react-docs-ui",
-  "version": "0.2.0",
-  "private": false,
-  "type": "module",
-  "bin": {
-    "create-react-docs-ui": "./index.js"
-  },
-  "files": [
-    "index.js",
-    "template/index.html",
-    "template/package.json",
-    "template/public/**/*",
-    "template/src/main.tsx",
-    "template/src/react-docs-ui.d.ts",
-    "template/src/vite-env.d.ts",
-    "template/tsconfig.app.json",
-    "template/tsconfig.json",
-    "template/vite.config.ts",
-    "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"
-  ],
-  "license": "MIT",
-  "engines": {
-    "node": ">=18"
-  },
-  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
-}
+{
+    "name": "create-react-docs-ui",
+    "version": "0.4.0",
+    "private": false,
+    "type": "module",
+    "bin": {
+        "create-react-docs-ui": "./index.js"
+    },
+    "files": [
+        "index.js",
+        "template/index.html",
+        "template/package.json",
+        "template/vite-plugin-mdx-components.ts",
+        "template/public/**/*",
+        "template/src/main.tsx",
+        "template/src/react-docs-ui.d.ts",
+        "template/src/vite-env.d.ts",
+        "template/src/components/**/*",
+        "template/tsconfig.app.json",
+        "template/tsconfig.json",
+        "template/vite.config.ts",
+        "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"
+    ],
+    "license": "MIT",
+    "engines": {
+        "node": ">=18"
+    },
+    "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
+}

package/template/index.html

@@ -1,15 +1,13 @@
-<!doctype html>
-<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>Docs</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>
-
-
+<!doctype html>
+<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</title>
+    </head>
+    <body>
+        <div id="root"></div>
+        <script type="module" src="/src/main.tsx"></script>
+    </body>
+</html>

package/template/package.json

@@ -1,32 +1,32 @@
-{
-  "name": "my-react-docs-project",
-  "version": "0.0.1",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc -b && vite build",
-    "preview": "vite preview"
-  },
-  "dependencies": {
-    "react-docs-ui": "^0.2.0",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "react-router-dom": "^7.8.0"
-  },
-  "devDependencies": {
-    "@types/debug": "^4.1.12",
-    "@types/hast": "^3.0.4",
-    "@types/mdast": "^4.0.4",
-    "@types/ms": "^2.1.0",
-    "@types/react": "^19.1.9",
-    "@types/react-dom": "^19.1.7",
-    "@types/unist": "^3.0.3",
-    "@vitejs/plugin-react": "^4.7.0",
-    "typescript": "~5.8.3",
-    "vite": "^7.1.0"
-  },
-  "engines": {
-    "node": ">=18"
-  }
-}
+{
+    "name": "my-react-docs-project",
+    "version": "0.1.0",
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "vite",
+        "build": "tsc -b && vite build",
+        "preview": "vite preview"
+    },
+    "dependencies": {
+        "react": "^19.0.0",
+        "react-docs-ui": "^0.4.0",
+        "react-dom": "^19.0.0",
+        "react-router-dom": "^7.8.0"
+    },
+    "devDependencies": {
+        "@types/debug": "^4.1.12",
+        "@types/hast": "^3.0.4",
+        "@types/ms": "^2.1.0",
+        "@types/react": "^19.1.9",
+        "@types/react-dom": "^19.1.7",
+        "@types/unist": "^3.0.3",
+        "@vitejs/plugin-react": "^4.7.0",
+        "typescript": "~5.8.3",
+        "unist-util-visit": "^5.0.0",
+        "vite": "^7.1.0"
+    },
+    "engines": {
+        "node": ">=18"
+    }
+}