create-react-docs-ui 0.1.2 → 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 shenjianZ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOTT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# 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).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-docs-ui",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "private": false,
   "type": "module",
   "bin": {
@@ -12,6 +12,7 @@
     "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",

package/template/package.json

@@ -9,15 +9,20 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "react-docs-ui": "^0.1.2",
     "buffer": "^6.0.3",
     "react": ">=18",
+    "react-docs-ui": "^0.1.3",
     "react-dom": ">=18",
     "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"

package/template/public/docs/en/guide.md

@@ -4,7 +4,7 @@ This guide will help you fully understand and master all the features of React D
 
 ## Table of Contents
 
-- **[Introduction](/en/guide/introduction)**: Learn about the core philosophy and main advantages of React Docs UI.
-- **[Installation](/en/guide/installation)**: Learn how to install via the scaffolding tool or manually.
-- **[Quick Start](/en/guide/quick-start)**: Create and run your first documentation website in 5 minutes.
-- **[Configuration (`site.yaml`)](/en/guide/configuration)**: Dive deep into each configuration option to take full control of your site.
+- **[Introduction](/guide/introduction)**: Learn about the core philosophy and main advantages of React Docs UI.
+- **[Installation](/guide/installation)**: Learn how to install via the scaffolding tool or manually.
+- **[Quick Start](/guide/quick-start)**: Create and run your first documentation website in 5 minutes.
+- **[Configuration (`site.yaml`)](/guide/configuration)**: Dive deep into each configuration option to take full control of your site.

package/template/public/docs/en/index.md

@@ -30,5 +30,5 @@ npm install && npm run dev
 
 ## Links
 
-- **[Guide](/en/guide/introduction)**: Start learning about all the features of React Docs UI.
+- **[Guide](/guide/introduction)**: Start learning about all the features of React Docs UI.
 - **[GitHub](https://github.com/shenjianZ/react-docs-ui)**: View the source code, submit issues, or contribute.

package/template/public/docs/zh-cn/guide.md

@@ -4,7 +4,7 @@
 
 ## 目录
 
-- **[介绍](/zh-cn/guide/introduction)**: 了解 React Docs UI 的核心理念和主要优势。
-- **[安装](/zh-cn/guide/installation)**: 学习如何通过脚手架或手动方式安装。
-- **[快速上手](/zh-cn/guide/quick-start)**: 在 5 分钟内创建并运行你的第一个文档网站。
-- **[配置说明 (`site.yaml`)](/zh-cn/guide/configuration)**: 深入了解每个配置项，完全掌控你的网站。
+- **[介绍](/guide/introduction)**: 了解 React Docs UI 的核心理念和主要优势。
+- **[安装](/guide/installation)**: 学习如何通过脚手架或手动方式安装。
+- **[快速上手](/guide/quick-start)**: 在 5 分钟内创建并运行你的第一个文档网站。
+- **[配置说明 (`site.yaml`)](/guide/configuration)**: 深入了解每个配置项，完全掌控你的网站。

package/template/public/docs/zh-cn/index.md

@@ -30,5 +30,5 @@ npm install && npm run dev
 
 ## 链接
 
-- **[指南](/zh-cn/guide/introduction)**: 开始了解 React Docs UI 的所有功能。
+- **[指南](/guide/introduction)**: 开始了解 React Docs UI 的所有功能。
 - **[GitHub](https://github.com/shenjianZ/react-docs-ui)**: 查看源码、提交问题或贡献代码。

package/template/src/react-docs-ui.d.ts

@@ -0,0 +1 @@
+declare module 'react-docs-ui';