create-react-docs-ui 0.6.4 → 0.6.7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-react-docs-ui",
-    "version": "0.6.4",
+    "version": "0.6.7",
     "private": false,
     "type": "module",
     "bin": {

package/template/package.json

@@ -14,7 +14,7 @@
         "flexsearch": "^0.8.212",
         "gray-matter": "^4.0.3",
         "react": "^19.0.0",
-        "react-docs-ui": "^0.6.4",
+        "react-docs-ui": "^0.6.7",
         "react-dom": "^19.0.0",
         "react-router-dom": "^7.8.0"
     },

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

@@ -27,6 +27,18 @@ navbar:
         - type: "github"
           link: "https://github.com/shenjianZ/React-docs-ui"
           enabled: true
+        # Common code hosting / external links are supported out of the box.
+        # Available icon/type examples: github, gitee, gitea, gitlab, link, external, globe
+        - type: "gitee"
+          link: "https://gitee.com/your-org/your-repo"
+          enabled: false
+        - type: "gitea"
+          link: "https://git.example.com/your-org/your-repo"
+          enabled: false
+        - title: "API"
+          icon: "link"
+          link: "https://example.com/api"
+          enabled: false
 
 # Sidebar Navigation Configuration
 sidebar:
@@ -45,6 +57,8 @@ sidebar:
                         path: "/docs/guide/quick-start"
                       - title: "Configuration"
                         path: "/docs/guide/configuration"
+                      - title: "PDF Server Deployment"
+                        path: "/docs/guide/pdf-server"
                 - title: "Documentation Tests"
                   path: "/docs/test"
                   children:
@@ -222,3 +236,16 @@ search:
     placeholder: "Search docs..."
     maxResults: 20
     snippetLength: 120
+
+# Export Configuration
+export:
+    enabled: true
+    markdown: true
+    pdf: true
+    word: true
+    allDocs: true
+    # PDF Server Configuration (optional)
+    # When enabled, PDF will be generated server-side, otherwise use browser native print
+    pdfServer:
+        enabled: false
+        url: "http://localhost:3001"

package/template/public/config/site.yaml

@@ -27,6 +27,18 @@ navbar:
         - type: "github"
           link: "https://github.com/shenjianZ/React-docs-ui"
           enabled: true
+        # 支持常见代码托管/外链平台，也支持按 icon/type 自定义
+        # 可选 icon/type 示例：github、gitee、gitea、gitlab、link、external、globe
+        - type: "gitee"
+          link: "https://gitee.com/your-org/your-repo"
+          enabled: false
+        - type: "gitea"
+          link: "https://git.example.com/your-org/your-repo"
+          enabled: false
+        - title: "API"
+          icon: "link"
+          link: "https://example.com/api"
+          enabled: false
 
 # 侧边栏导航配置
 sidebar:
@@ -45,6 +57,8 @@ sidebar:
                         path: "/docs/guide/quick-start"
                       - title: "配置说明"
                         path: "/docs/guide/configuration"
+                      - title: "PDF Server 部署"
+                        path: "/docs/guide/pdf-server"
                 - title: "文档测试"
                   path: "/docs/test"
                   children:
@@ -221,3 +235,15 @@ search:
     placeholder: "搜索文档..."
     maxResults: 20
     snippetLength: 120
+
+export:
+    enabled: true
+    markdown: true
+    pdf: true
+    word: true
+    allDocs: true
+    # PDF 服务器配置 (可选)
+    # 启用后将使用服务器端生成 PDF，否则使用浏览器原生打印
+    pdfServer:
+        enabled: false
+        url: "http://localhost:3001"

package/template/public/docs/en/docs/guide/pdf-server.md

@@ -0,0 +1,85 @@
+# PDF Server Deployment
+
+React Docs UI provides a PDF generation service that can be deployed as a standalone Docker container.
+
+## Pull Image
+
+```bash
+docker pull registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+```
+
+## Run Container
+
+### Using Docker Command
+
+```bash
+docker run -d \
+  --name pdf-server \
+  --memory=512m \
+  -p 6965:6965 \
+  registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+```
+
+### Using Docker Compose
+
+Create `docker-compose.yml` file:
+
+```yaml
+services:
+  pdf-server:
+    image: registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+    container_name: pdf-server
+    mem_limit: 512m
+    ports:
+      - "6965:6965"
+    restart: unless-stopped
+```
+
+Start service:
+
+```bash
+docker-compose up -d
+```
+
+## Verify Service
+
+```bash
+# Health check
+curl http://localhost:6965/health
+
+# Response example
+# {"status":"ok","timestamp":"2024-01-01T00:00:00.000Z"}
+```
+
+## API Endpoints
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/health` | GET | Health check |
+| `/generate-pdf` | POST | Generate PDF (returns file) |
+| `/generate-pdf-sync` | POST | Generate PDF (returns Base64) |
+
+### Generate PDF Example
+
+```bash
+curl -X POST http://localhost:6965/generate-pdf \
+  -H "Content-Type: application/json" \
+  -d '{"url": "https://example.com", "filename": "document.pdf"}' \
+  --output document.pdf
+```
+
+## Resource Configuration
+
+PDF Server runs on Puppeteer/Chromium, recommended configuration:
+
+| Scenario | Recommended Memory |
+|----------|-------------------|
+| Low concurrency (1-2 requests) | 512MB |
+| Medium concurrency | 1GB |
+| High concurrency | 2GB+ |
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `PDF_SERVER_PORT` | 3001 | Server port (Docker image default: 6965) |

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

@@ -8,6 +8,7 @@ Welcome to the React Docs UI documentation system.
 - [Installation](/docs/guide/installation) - Learn how to install and configure
 - [Quick Start](/docs/guide/quick-start) - Create your first documentation site in 5 minutes
 - [Configuration](/docs/guide/configuration) - Deep dive into configuration options
+- [PDF Server Deployment](/docs/guide/pdf-server) - Deploy PDF generation service
 
 ## Documentation Tests
 

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

@@ -0,0 +1,85 @@
+# PDF Server 部署
+
+React Docs UI 提供了 PDF 生成服务，可以独立部署为 Docker 容器。
+
+## 拉取镜像
+
+```bash
+docker pull registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+```
+
+## 运行容器
+
+### 使用 Docker 命令
+
+```bash
+docker run -d \
+  --name pdf-server \
+  --memory=512m \
+  -p 6965:6965 \
+  registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+```
+
+### 使用 Docker Compose
+
+创建 `docker-compose.yml` 文件：
+
+```yaml
+services:
+  pdf-server:
+    image: registry.cn-hangzhou.aliyuncs.com/pull-image/react-docs-pdf-server:latest
+    container_name: pdf-server
+    mem_limit: 512m
+    ports:
+      - "6965:6965"
+    restart: unless-stopped
+```
+
+启动服务：
+
+```bash
+docker-compose up -d
+```
+
+## 验证服务
+
+```bash
+# 健康检查
+curl http://localhost:6965/health
+
+# 响应示例
+# {"status":"ok","timestamp":"2024-01-01T00:00:00.000Z"}
+```
+
+## API 接口
+
+| 端点 | 方法 | 说明 |
+|------|------|------|
+| `/health` | GET | 健康检查 |
+| `/generate-pdf` | POST | 生成 PDF（返回文件） |
+| `/generate-pdf-sync` | POST | 生成 PDF（返回 Base64） |
+
+### 生成 PDF 示例
+
+```bash
+curl -X POST http://localhost:6965/generate-pdf \
+  -H "Content-Type: application/json" \
+  -d '{"url": "https://example.com", "filename": "document.pdf"}' \
+  --output document.pdf
+```
+
+## 资源配置
+
+PDF Server 基于 Puppeteer/Chromium 运行，建议配置：
+
+| 场景 | 推荐内存 |
+|------|---------|
+| 低并发（1-2 请求） | 512MB |
+| 中等并发 | 1GB |
+| 高并发 | 2GB+ |
+
+## 环境变量
+
+| 变量 | 默认值 | 说明 |
+|------|--------|------|
+| `PDF_SERVER_PORT` | 3001 | 服务端口（Docker 镜像默认 6965） |

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

@@ -8,6 +8,7 @@
 - [安装](/docs/guide/installation) - 学习如何安装和配置
 - [快速上手](/docs/guide/quick-start) - 在 5 分钟内创建你的第一个文档网站
 - [配置说明](/docs/guide/configuration) - 深入了解配置选项
+- [PDF Server 部署](/docs/guide/pdf-server) - 部署 PDF 生成服务
 
 ## 文档测试