create-react-docs-ui 0.6.3 → 0.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-react-docs-ui",
-    "version": "0.6.3",
+    "version": "0.6.6",
     "private": false,
     "type": "module",
     "bin": {
@@ -11,15 +11,16 @@
         "template/index.html",
         "template/package.json",
         "template/vite-plugin-mdx-components.ts",
+        "template/vite.config.ts",
         "template/public/**/*",
         "template/src/main.tsx",
         "template/src/index.css",
         "template/src/react-docs-ui.d.ts",
         "template/src/vite-env.d.ts",
         "template/src/components/**/*",
+        "template/scripts/**/*",
         "template/tsconfig.app.json",
         "template/tsconfig.json",
-        "template/vite.config.ts",
         "README.md",
         "README-zh.md"
     ],

package/template/package.json

@@ -5,12 +5,16 @@
     "type": "module",
     "scripts": {
         "dev": "vite",
-        "build": "tsc -b && vite build",
-        "preview": "vite preview"
+        "build": "npm run build:search && tsc -b && vite build",
+        "preview": "vite preview",
+        "build:search": "node scripts/generate-search-index.js"
     },
     "dependencies": {
+        "buffer": "^6.0.3",
+        "flexsearch": "^0.8.212",
+        "gray-matter": "^4.0.3",
         "react": "^19.0.0",
-        "react-docs-ui": "^0.6.3",
+        "react-docs-ui": "^0.6.6",
         "react-dom": "^19.0.0",
         "react-router-dom": "^7.8.0"
     },
@@ -22,7 +26,10 @@
         "@types/react-dom": "^19.1.7",
         "@types/unist": "^3.0.3",
         "@vitejs/plugin-react": "^4.7.0",
+        "remark-gfm": "^4.0.1",
+        "remark-parse": "^11.0.0",
         "typescript": "~5.8.3",
+        "unified": "^11.0.5",
         "unist-util-visit": "^5.0.0",
         "vite": "^7.1.0"
     },

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

@@ -45,6 +45,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:
@@ -54,6 +56,8 @@ sidebar:
                         path: "/docs/test/katex-test"
                       - title: "MDX Demo"
                         path: "/docs/test/mdx-test"
+                      - title: "Frontmatter Test"
+                        path: "/docs/test/frontmatter-test"
 
 # Theme Configuration
 theme:
@@ -213,3 +217,23 @@ ai:
 fonts:
     fontFamilyZhCn: "PingFang SC, Microsoft YaHei, Noto Sans SC, sans-serif"
     fontFamilyEn: "Fragment Mono, system-ui, sans-serif"
+
+# Full-text Search Configuration
+search:
+    enabled: true
+    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

@@ -45,6 +45,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:
@@ -54,6 +56,8 @@ sidebar:
                         path: "/docs/test/katex-test"
                       - title: "MDX 演示"
                         path: "/docs/test/mdx-test"
+                      - title: "Frontmatter测试"
+                        path: "/docs/test/frontmatter-test"
 
 # Theme Configuration
 theme:
@@ -212,3 +216,22 @@ ai:
 fonts:
     fontFamilyZhCn: "PingFang SC, Microsoft YaHei, Noto Sans SC, sans-serif"
     fontFamilyEn: "Fragment Mono, system-ui, sans-serif"
+
+# 全文搜索配置
+search:
+    enabled: true
+    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/test/frontmatter-test.md

@@ -0,0 +1,42 @@
+---
+title: Frontmatter Test Page
+description: This is a test page for demonstrating the Frontmatter field display functionality
+author: Development Team
+date: 2026-03-09
+---
+
+# Frontmatter Feature Test
+
+This page is used to test the display of Frontmatter fields.
+
+## Test Description
+
+If you can see the title, description, author, and date information at the top of the page, the Frontmatter display feature is working correctly.
+
+## Supported Fields
+
+| Field | Description |
+|-------|-------------|
+| `title` | Page title, displayed at the top of the content area and set as the browser tab title |
+| `description` | Page description, displayed below the title |
+| `author` | Author information, displayed below the description |
+| `date` | Publication date, displayed next to the author |
+
+## Regular Content
+
+This is regular Markdown content that will be rendered normally.
+
+- List item 1
+- List item 2
+- List item 3
+
+Code block test:
+
+```typescript
+const greeting = "Hello, Frontmatter!"
+console.log(greeting)
+```
+
+---
+
+Test completed ✅

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/test/frontmatter-test.md

@@ -0,0 +1,42 @@
+---
+title: Frontmatter 测试页面
+description: 这是一个用于测试 Frontmatter 字段展示功能的测试页面
+author: 开发团队
+date: 2026-03-09
+---
+
+# Frontmatter 功能测试
+
+这个页面用于测试 Frontmatter 字段的展示功能。
+
+## 测试说明
+
+如果你能看到页面上方的标题、描述、作者和日期信息，说明 Frontmatter 展示功能正常工作。
+
+## 支持的字段
+
+| 字段 | 说明 |
+|------|------|
+| `title` | 页面标题，会显示在内容区顶部，并设置为浏览器标签页标题 |
+| `description` | 页面描述，显示在标题下方 |
+| `author` | 作者信息，显示在描述下方 |
+| `date` | 发布日期，显示在作者旁边 |
+
+## 普通内容
+
+这里是普通的 Markdown 内容，会正常渲染。
+
+- 列表项 1
+- 列表项 2
+- 列表项 3
+
+代码块测试：
+
+```typescript
+const greeting = "Hello, Frontmatter!"
+console.log(greeting)
+```
+
+---
+
+测试完成 ✅

package/template/public/docs/zh-cn/docs/test/mdx-test.mdx

@@ -91,24 +91,7 @@ Callout 组件用于强调重要内容：
     这是一个次要样式的 Callout，用于补充说明。
 </Callout>
 
-### StepList 组件
-
-StepList 组件用于展示步骤流程：
-
-<StepList>
-    <StepList.Step title="安装依赖">
-        运行 `npm install` 命令安装项目所需的依赖包。
-    </StepList.Step>
-    <StepList.Step title="配置环境">
-        根据项目需求配置环境变量和开发环境。
-    </StepList.Step>
-    <StepList.Step title="启动项目">
-        运行 `npm run dev` 启动开发服务器。
-    </StepList.Step>
-    <StepList.Step title="开始开发">
-        开始编写代码，实现你的功能需求。
-    </StepList.Step>
-</StepList>
+
 
 ### BadgeList 组件
 

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 生成服务
 
 ## 文档测试
 

package/template/public/search-index-en.json

@@ -0,0 +1 @@
+{"version":"2.0.0","generatedAt":1773044368774,"lang":"en","sections":[{"id":"docs-guide-configuration--configuration-file-site-yaml-explained","pageTitle":"","sectionTitle":"Configuration File ( `site.yaml` ) Explained","content":"The project is configuration-driven. Most behavior is defined in public/config/site.yaml . This page documents every field using concise tables.","url":"/en/docs\\guide\\configuration#configuration-file-site-yaml-explained","lang":"en","tokens":["configuration","file","site","yaml","explained","the","project","is","driven","most","behavior","defined","in","public","config","this","page","documents","every","field","using","concise","tables"]},{"id":"docs-guide-configuration--top-level-keys","pageTitle":"","sectionTitle":"Top-level keys","content":"Key Purpose site Global metadata like title, description, logo, author navbar Top navigation bar (logo/title toggles, items, actions) sidebar Left navigation tree (collections/sections/children) theme Theme options (default mode, toggle) toc Article table of contents (enabled, levels, title) footer ...","url":"/en/docs\\guide\\configuration#top-level-keys","lang":"en","tokens":["top","level","keys","key","purpose","site","global","metadata","like","title","description","logo","author","navbar","navigation","bar","toggles","items","actions","sidebar","left","tree","collections","sections","children","theme","options","default","mode","toggle","toc","article","table","of","contents","enabled","levels","footer","links","socials","repository","meta","contextmenu","context","menu","configuration","mdx","component","pwa","progressive","web","app","settings","reserved","optional"]},{"id":"docs-guide-configuration--site","pageTitle":"","sectionTitle":"`site`","content":"Field Type Description Example title string Site title \"React Docs UI Example\" description string Short site description (SEO) \"Beautiful docs made simple\" logo string or object Logo to display. String can be emoji or image path. Object allows light/dark images. \"📚\" , \"/images/logo.png\" , or { ligh...","url":"/en/docs\\guide\\configuration#site","lang":"en","tokens":["site","field","type","description","example","title","string","react","docs","ui","short","seo","beautiful","made","simple","logo","or","object","to","display","can","be","emoji","image","path","allows","light","dark","images","png","favicon","svg","author","organization","team","formats","supported","url","public"]},{"id":"docs-guide-configuration--navbar","pageTitle":"","sectionTitle":"`navbar`","content":"Field Type Description showLogo boolean Show logo at top-left showTitle boolean Show site title in navbar showLanguageSwitcher boolean Show language switcher items array Primary navigation links actions array Right-side action buttons (e.g. GitHub) Item Field Type Description Example title string Li...","url":"/en/docs\\guide\\configuration#navbar","lang":"en","tokens":["navbar","field","type","description","showlogo","boolean","show","logo","at","top","left","showtitle","site","title","in","showlanguageswitcher","language","switcher","items","array","primary","navigation","links","actions","right","side","action","buttons","e","g","github","item","example","string","link","text","guide","path","or","url","internal","paths","start","with","external","optional","open","new","tab","if","true","visible","conditionally","hide","custom","predefined","button","when","is","destination","icon","name","for","enabled","toggle","the"]},{"id":"docs-guide-configuration--sidebar","pageTitle":"","sectionTitle":"`sidebar`","content":"Field Type Description enabled boolean (optional) Global toggle for sidebar collections record<string, Collection Map of top-level sections (e.g. guide ) sections Section[] (legacy, optional) Backward-compatible single-tree definition Collection Field Type Description sections Section[] Grouped side...","url":"/en/docs\\guide\\configuration#sidebar","lang":"en","tokens":["sidebar","field","type","description","enabled","boolean","optional","global","toggle","for","collections","record","string","collection","map","of","top","level","sections","e","g","guide","section","legacy","backward","compatible","single","tree","definition","grouped","side","nav","example","title","getting","started","path","base","that","expands","highlights","this","children","child","leaf","links","under","the","link","text","introduction","full","page"]},{"id":"docs-guide-configuration--theme","pageTitle":"","sectionTitle":"`theme`","content":"Field Type Description Options Default defaultMode string Default color mode light , dark , auto auto allowToggle boolean Allow user theme switching true / false true","url":"/en/docs\\guide\\configuration#theme","lang":"en","tokens":["theme","field","type","description","options","default","defaultmode","string","color","mode","light","dark","auto","allowtoggle","boolean","allow","user","switching","true","false"]},{"id":"docs-guide-configuration--toc","pageTitle":"","sectionTitle":"`toc`","content":"Field Type Description Example enabled boolean Enable page table of contents true maxLevel number (1-6) Max heading depth to show 3 title string TOC panel title \"On This Page\" Note: Per-page TOC visibility/anchors are also affected by page frontmatter.","url":"/en/docs\\guide\\configuration#toc","lang":"en","tokens":["toc","field","type","description","example","enabled","boolean","enable","page","table","of","contents","true","maxlevel","number","1","6","max","heading","depth","to","show","3","title","string","panel","on","this","note","per","visibility","anchors","are","also","affected","by","frontmatter"]},{"id":"docs-guide-configuration--footer","pageTitle":"","sectionTitle":"`footer`","content":"Field Type Description enabled boolean Show footer copyright string Copyright text repository Repository (optional) Repo info used for links like “Edit this page” lastUpdated string (optional) Site/content last update date links Link[] (optional) Footer link columns social Social[] (optional) Social...","url":"/en/docs\\guide\\configuration#footer","lang":"en","tokens":["footer","field","type","description","enabled","boolean","show","copyright","string","text","repository","optional","repo","info","used","for","links","like","edit","this","page","lastupdated","site","content","last","update","date","link","columns","social","icon","example","url","https","github","com","user","branch","docs","main","title","path","or","external","open","in","new","tab","name","provider","key","e","g","twitter","bilibili","profile"]},{"id":"docs-guide-configuration--contextmenu","pageTitle":"","sectionTitle":"`contextMenu`","content":"Field Type Description enabled boolean Global switch, set to false to completely disable context menu page object Page group menu items configuration site object Site group menu items configuration appearance object Appearance group menu items configuration Page Field Type Description Default copySe...","url":"/en/docs\\guide\\configuration#contextmenu","lang":"en","tokens":["contextmenu","field","type","description","enabled","boolean","global","switch","set","to","false","completely","disable","context","menu","page","object","group","items","configuration","site","appearance","default","copyselectedtext","copy","selected","text","true","copyurl","current","url","copytitle","title","copymarkdownlink","markdown","link","openinnewtab","open","in","new","tab","reload","refresh","printpage","print","scrolltotop","scroll","top","scrolltobottom","bottom","gohome","go","home","quicknav","quick","navigation","language","theme","resetthemepref","reset","preference"]},{"id":"docs-guide-configuration--mdx","pageTitle":"","sectionTitle":"`mdx`","content":"Field Type Description Example componentsPath string Component scan path \"/src/components\" enabled boolean Enable MDX support true","url":"/en/docs\\guide\\configuration#mdx","lang":"en","tokens":["mdx","field","type","description","example","componentspath","string","component","scan","path","src","components","enabled","boolean","enable","support","true"]},{"id":"docs-guide-configuration--pwa-optional","pageTitle":"","sectionTitle":"`pwa`  (optional)","content":"Field Type Description enabled boolean Enable PWA features (reserved) name string App name shortName string Short app name description string App description themeColor string Theme color backgroundColor string Background color","url":"/en/docs\\guide\\configuration#pwa-optional","lang":"en","tokens":["pwa","optional","field","type","description","enabled","boolean","enable","features","reserved","name","string","app","shortname","short","themecolor","theme","color","backgroundcolor","background"]},{"id":"docs-guide-installation--prerequisites","pageTitle":"","sectionTitle":"Prerequisites","content":"Before you begin, make sure your development environment meets the following requirements: Node.js : Version = 18.0.0 Package Manager : npm , yarn , or pnpm","url":"/en/docs\\guide\\installation#prerequisites","lang":"en","tokens":["prerequisites","before","you","begin","make","sure","your","development","environment","meets","the","following","requirements","node","js","version","18","0","package","manager","npm","yarn","or","pnpm"]},{"id":"docs-guide-installation--recommended-method-use-the-scaffolding-tool","pageTitle":"","sectionTitle":"Recommended Method: Use the Scaffolding Tool","content":"We strongly recommend using the official create-react-docs-ui scaffolding tool to create your new documentation project. This is the fastest and easiest way to ensure all configurations are set up correctly. Run the creation command : This will create a new folder named my-docs in the current direct...","url":"/en/docs\\guide\\installation#recommended-method-use-the-scaffolding-tool","lang":"en","tokens":["recommended","method","use","the","scaffolding","tool","we","strongly","recommend","using","official","create","react","docs","ui","to","your","new","documentation","project","this","is","fastest","and","easiest","way","ensure","all","configurations","are","set","up","correctly","run","creation","command","will","a","folder","named","my","in","current","directory","enter","install","dependencies","start","development","server","website","now","running","at","http","localhost","5173","or","another","available","port"]},{"id":"docs-guide-installation--manual-installation-for-existing-projects","pageTitle":"","sectionTitle":"Manual Installation (for existing projects)","content":"If you want to manually integrate react-docs-ui into an existing Vite + React project, follow these steps: Install the core library : Create configuration files : In your public directory, create a config folder, and inside it, create a site.yaml file. You can copy a basic template from here . Creat...","url":"/en/docs\\guide\\installation#manual-installation-for-existing-projects","lang":"en","tokens":["manual","installation","for","existing","projects","if","you","want","to","manually","integrate","react","docs","ui","into","an","vite","project","follow","these","steps","install","the","core","library","create","configuration","files","in","your","public","directory","a","config","folder","and","inside","it","site","yaml","file","can","copy","basic","template","from","here","documentation","store","markdown","example","en","index","md","modify","application","entry","update","src","main","tsx","or","jsx","render","docsapp","component","initialize","ensure","html","contains","div","id","root"]},{"id":"docs-guide-introduction--introduction","pageTitle":"","sectionTitle":"Introduction","content":"React Docs UI is a React component library and toolset designed specifically for building modern documentation websites. Its core philosophy is configuration over code , allowing you to focus entirely on content creation.","url":"/en/docs\\guide\\introduction#introduction","lang":"en","tokens":["introduction","react","docs","ui","is","a","component","library","and","toolset","designed","specifically","for","building","modern","documentation","websites","its","core","philosophy","configuration","over","code","allowing","you","to","focus","entirely","on","content","creation"]},{"id":"docs-guide-introduction--core-advantages","pageTitle":"","sectionTitle":"Core Advantages","content":"Configuration-Driven : This is the core feature of React Docs UI. You don't need to write complex React components or routing logic; just maintain a clear site.yaml file to define everything from the site's navigation and sidebar to its theme and footer. Fully-Featured : Out-of-the-box, it provides ...","url":"/en/docs\\guide\\introduction#core-advantages","lang":"en","tokens":["core","advantages","configuration","driven","this","is","the","feature","of","react","docs","ui","you","don","t","need","to","write","complex","components","or","routing","logic","just","maintain","a","clear","site","yaml","file","define","everything","from","s","navigation","and","sidebar","its","theme","footer","fully","featured","out","box","it","provides","modern","documentation","website","needs","responsive","layout","light","dark","switching","markdown","based","content","rendering","with","gfm","frontmatter","support","built","in","code","syntax","highlighting","quick","command","menu","cmd","k","internationalization","extremely","simple","start","official","create","scaffolding","tool","can","launch","functional","under","minute","without","any","environment","setup","highly","customizable","while","works","every","part","like","logo","color","scheme","links","social","media","icons","etc","be","deeply","customized","through"]},{"id":"docs-guide-introduction--use-cases","pageTitle":"","sectionTitle":"Use Cases","content":"Whether you are an individual developer or part of a team, React Docs UI is perfect for the following scenarios: Open Source Project Documentation : Provide a professional and easy-to-maintain documentation site for your React project. Product Manuals : Clearly present your product's features and us...","url":"/en/docs\\guide\\introduction#use-cases","lang":"en","tokens":["use","cases","whether","you","are","an","individual","developer","or","part","of","a","team","react","docs","ui","is","perfect","for","the","following","scenarios","open","source","project","documentation","provide","professional","and","easy","to","maintain","site","your","product","manuals","clearly","present","s","features","usage","guides","knowledge","bases","build","share","based","on","technology","within","personal","blogs","portfolios","organize","display","technical","articles","projects","in","elegant","way"]},{"id":"docs-guide-pdf-server--pdf-server-deployment","pageTitle":"","sectionTitle":"PDF Server Deployment","content":"React Docs UI provides a PDF generation service that can be deployed as a standalone Docker container.","url":"/en/docs\\guide\\pdf-server#pdf-server-deployment","lang":"en","tokens":["pdf","server","deployment","react","docs","ui","provides","a","generation","service","that","can","be","deployed","as","standalone","docker","container"]},{"id":"docs-guide-pdf-server--using-docker-compose","pageTitle":"","sectionTitle":"Using Docker Compose","content":"Create docker-compose.yml file: Start service:","url":"/en/docs\\guide\\pdf-server#using-docker-compose","lang":"en","tokens":["using","docker","compose","create","yml","file","start","service"]},{"id":"docs-guide-pdf-server--api-endpoints","pageTitle":"","sectionTitle":"API Endpoints","content":"Endpoint Method Description /health GET Health check /generate-pdf POST Generate PDF (returns file) /generate-pdf-sync POST Generate PDF (returns Base64)","url":"/en/docs\\guide\\pdf-server#api-endpoints","lang":"en","tokens":["api","endpoints","endpoint","method","description","health","get","check","generate","pdf","post","returns","file","sync","base64"]},{"id":"docs-guide-pdf-server--resource-configuration","pageTitle":"","sectionTitle":"Resource Configuration","content":"PDF Server runs on Puppeteer/Chromium, recommended configuration: Scenario Recommended Memory Low concurrency (1-2 requests) 512MB Medium concurrency 1GB High concurrency 2GB+","url":"/en/docs\\guide\\pdf-server#resource-configuration","lang":"en","tokens":["resource","configuration","pdf","server","runs","on","puppeteer","chromium","recommended","scenario","memory","low","concurrency","1","2","requests","512mb","medium","1gb","high","2gb"]},{"id":"docs-guide-pdf-server--environment-variables","pageTitle":"","sectionTitle":"Environment Variables","content":"Variable Default Description PDFSERVERPORT 3001 Server port (Docker image default: 6965)","url":"/en/docs\\guide\\pdf-server#environment-variables","lang":"en","tokens":["environment","variables","variable","default","description","pdfserverport","3001","server","port","docker","image","6965"]},{"id":"docs-guide-quick-start--quick-start","pageTitle":"","sectionTitle":"Quick Start","content":"This guide will walk you through creating, configuring, and running your own React documentation website from scratch in 5 minutes.","url":"/en/docs\\guide\\quick-start#quick-start","lang":"en","tokens":["quick","start","this","guide","will","walk","you","through","creating","configuring","and","running","your","own","react","documentation","website","from","scratch","in","5","minutes"]},{"id":"docs-guide-quick-start--1-create-project","pageTitle":"","sectionTitle":"1. Create Project","content":"Using the official scaffold is the most efficient way. Open your terminal and run the following command: Then, navigate to the project directory and install dependencies:","url":"/en/docs\\guide\\quick-start#1-create-project","lang":"en","tokens":["1","create","project","using","the","official","scaffold","is","most","efficient","way","open","your","terminal","and","run","following","command","then","navigate","to","directory","install","dependencies"]},{"id":"docs-guide-quick-start--2-organize-your-documentation","pageTitle":"","sectionTitle":"2. Organize Your Documentation","content":"All documentation content is stored as Markdown files in the public/docs/ directory. Open the public/docs/en/ directory. You can modify the existing index.md and files in the guide directory, or create new .md files. For example, let's create a new page. Create an about directory and an about.md fil...","url":"/en/docs\\guide\\quick-start#2-organize-your-documentation","lang":"en","tokens":["2","organize","your","documentation","all","content","is","stored","as","markdown","files","in","the","public","docs","directory","open","en","you","can","modify","existing","index","md","and","guide","or","create","new","for","example","let","s","a","page","an","about","file","with","following"]},{"id":"docs-guide-quick-start--3-configure-the-website","pageTitle":"","sectionTitle":"3. Configure the Website","content":"Now, let's display the newly created page by modifying the configuration file. Open the core configuration file public/config/site.en.yaml .","url":"/en/docs\\guide\\quick-start#3-configure-the-website","lang":"en","tokens":["3","configure","the","website","now","let","s","display","newly","created","page","by","modifying","configuration","file","open","core","public","config","site","en","yaml"]},{"id":"docs-guide-quick-start--a-modify-website-information","pageTitle":"","sectionTitle":"a. Modify Website Information","content":"Update the site section to give your website a new title and Logo.","url":"/en/docs\\guide\\quick-start#a-modify-website-information","lang":"en","tokens":["a","modify","website","information","update","the","site","section","to","give","your","new","title","and","logo"]},{"id":"docs-guide-quick-start--b-add-to-navigation-bar","pageTitle":"","sectionTitle":"b. Add to Navigation Bar","content":"Add a link for the \"About\" page in the navbar.items array.","url":"/en/docs\\guide\\quick-start#b-add-to-navigation-bar","lang":"en","tokens":["b","add","to","navigation","bar","a","link","for","the","about","page","in","navbar","items","array"]},{"id":"docs-guide-quick-start--c-add-to-sidebar","pageTitle":"","sectionTitle":"c. Add to Sidebar","content":"To make the \"About\" page visible in the sidebar as well, create a new sidebar.collections.about.sections and add a new entry. Here, the about item in the sidebar also needs to create a file about.md under public/docs/en/about","url":"/en/docs\\guide\\quick-start#c-add-to-sidebar","lang":"en","tokens":["c","add","to","sidebar","make","the","about","page","visible","in","as","well","create","a","new","collections","sections","and","entry","here","item","also","needs","file","md","under","public","docs","en"]},{"id":"docs-guide-quick-start--4-launch-the-website","pageTitle":"","sectionTitle":"4. Launch the Website","content":"Save all your changes, then run in the terminal: Your website should now be running at http://localhost:5173 . Visit it, and you will see the updated title, Logo, and the newly added \"About\" link in the navigation bar and sidebar. Congratulations, you have successfully mastered the basic workflow of...","url":"/en/docs\\guide\\quick-start#4-launch-the-website","lang":"en","tokens":["4","launch","the","website","save","all","your","changes","then","run","in","terminal","should","now","be","running","at","http","localhost","5173","visit","it","and","you","will","see","updated","title","logo","newly","added","about","link","navigation","bar","sidebar","congratulations","have","successfully","mastered","basic","workflow","of","react","docs","ui"]},{"id":"docs-guide--guide","pageTitle":"","sectionTitle":"Guide","content":"This guide will help you fully understand and master all the features of React Docs UI. Whether you are a beginner or looking for in-depth customization, you will find the information you need here.","url":"/en/docs\\guide#guide","lang":"en","tokens":["guide","this","will","help","you","fully","understand","and","master","all","the","features","of","react","docs","ui","whether","are","a","beginner","or","looking","for","in","depth","customization","find","information","need","here"]},{"id":"docs-guide--table-of-contents","pageTitle":"","sectionTitle":"Table of Contents","content":"Introduction : Learn about the core philosophy and main advantages of React Docs UI. Installation : Learn how to install via the scaffolding tool or manually. Quick Start : Create and run your first documentation website in 5 minutes. Configuration ( site.yaml ) : Dive deep into each configuration o...","url":"/en/docs\\guide#table-of-contents","lang":"en","tokens":["table","of","contents","introduction","learn","about","the","core","philosophy","and","main","advantages","react","docs","ui","installation","how","to","install","via","scaffolding","tool","or","manually","quick","start","create","run","your","first","documentation","website","in","5","minutes","configuration","site","yaml","dive","deep","into","each","option","take","full","control"]},{"id":"docs-test-frontmatter-test--frontmatter-feature-test","pageTitle":"Frontmatter Test Page","sectionTitle":"Frontmatter Feature Test","content":"This page is used to test the display of Frontmatter fields.","url":"/en/docs\\test\\frontmatter-test#frontmatter-feature-test","lang":"en","tokens":["frontmatter","feature","test","this","page","is","used","to","the","display","of","fields"]},{"id":"docs-test-frontmatter-test--test-description","pageTitle":"Frontmatter Test Page","sectionTitle":"Test Description","content":"If you can see the title, description, author, and date information at the top of the page, the Frontmatter display feature is working correctly.","url":"/en/docs\\test\\frontmatter-test#test-description","lang":"en","tokens":["test","description","if","you","can","see","the","title","author","and","date","information","at","top","of","page","frontmatter","display","feature","is","working","correctly"]},{"id":"docs-test-frontmatter-test--supported-fields","pageTitle":"Frontmatter Test Page","sectionTitle":"Supported Fields","content":"Field Description title Page title, displayed at the top of the content area and set as the browser tab title description Page description, displayed below the title author Author information, displayed below the description date Publication date, displayed next to the author","url":"/en/docs\\test\\frontmatter-test#supported-fields","lang":"en","tokens":["supported","fields","field","description","title","page","displayed","at","the","top","of","content","area","and","set","as","browser","tab","below","author","information","date","publication","next","to"]},{"id":"docs-test-frontmatter-test--regular-content","pageTitle":"Frontmatter Test Page","sectionTitle":"Regular Content","content":"This is regular Markdown content that will be rendered normally. List item 1 List item 2 List item 3 Code block test: Test completed ✅","url":"/en/docs\\test\\frontmatter-test#regular-content","lang":"en","tokens":["regular","content","this","is","markdown","that","will","be","rendered","normally","list","item","1","2","3","code","block","test","completed"]},{"id":"docs-test-katex-test--katex-full-feature-test","pageTitle":"","sectionTitle":"🧪 KaTeX Full Feature Test","content":"Used to verify that KaTeX correctly loads all extensions (mhchem / physics / mathtools, etc.)","url":"/en/docs\\test\\katex-test#katex-full-feature-test","lang":"en","tokens":["katex","full","feature","test","used","to","verify","that","correctly","loads","all","extensions","mhchem","physics","mathtools","etc"]},{"id":"docs-test-katex-test--inline-formulas","pageTitle":"","sectionTitle":"✅ Inline Formulas","content":"Einstein's mass-energy equation:  Euler's formula:  Fraction test:  Root test:","url":"/en/docs\\test\\katex-test#inline-formulas","lang":"en","tokens":["inline","formulas","einstein","s","mass","energy","equation","euler","formula","fraction","test","root"]},{"id":"docs-test-katex-test--block-formulas","pageTitle":"","sectionTitle":"✅ Block Formulas","content":"","url":"/en/docs\\test\\katex-test#block-formulas","lang":"en","tokens":["block","formulas"]},{"id":"docs-test-katex-test--basic-matrix","pageTitle":"","sectionTitle":"Basic Matrix","content":"","url":"/en/docs\\test\\katex-test#basic-matrix","lang":"en","tokens":["basic","matrix"]},{"id":"docs-test-katex-test--parentheses-matrix","pageTitle":"","sectionTitle":"Parentheses Matrix","content":"","url":"/en/docs\\test\\katex-test#parentheses-matrix","lang":"en","tokens":["parentheses","matrix"]},{"id":"docs-test-katex-test--bracket-matrix","pageTitle":"","sectionTitle":"Bracket Matrix","content":"","url":"/en/docs\\test\\katex-test#bracket-matrix","lang":"en","tokens":["bracket","matrix"]},{"id":"docs-test-katex-test--determinant","pageTitle":"","sectionTitle":"Determinant","content":"","url":"/en/docs\\test\\katex-test#determinant","lang":"en","tokens":["determinant"]},{"id":"docs-test-katex-test--alignment-environment-ams","pageTitle":"","sectionTitle":"✅ Alignment Environment (ams)","content":"","url":"/en/docs\\test\\katex-test#alignment-environment-ams","lang":"en","tokens":["alignment","environment","ams"]},{"id":"docs-test-katex-test--piecewise-function","pageTitle":"","sectionTitle":"✅ Piecewise Function","content":"","url":"/en/docs\\test\\katex-test#piecewise-function","lang":"en","tokens":["piecewise","function"]},{"id":"docs-test-katex-test--chemical-formulas-mhchem","pageTitle":"","sectionTitle":"✅ Chemical Formulas (mhchem)","content":"Water:  Combustion reaction:  Reversible reaction:  Ions:","url":"/en/docs\\test\\katex-test#chemical-formulas-mhchem","lang":"en","tokens":["chemical","formulas","mhchem","water","combustion","reaction","reversible","ions"]},{"id":"docs-test-katex-test--physics-macro-test","pageTitle":"","sectionTitle":"✅ Physics Macro Test","content":"Derivative:  Partial derivative:  Second derivative:  Absolute value:  Norm:  Expectation value:  Auto-scaling parentheses:","url":"/en/docs\\test\\katex-test#physics-macro-test","lang":"en","tokens":["physics","macro","test","derivative","partial","second","absolute","value","norm","expectation","auto","scaling","parentheses"]},{"id":"docs-test-katex-test--mathtools-extensions","pageTitle":"","sectionTitle":"✅ mathtools Extensions","content":"Multi-line alignment:  With label:","url":"/en/docs\\test\\katex-test#mathtools-extensions","lang":"en","tokens":["mathtools","extensions","multi","line","alignment","with","label"]},{"id":"docs-test-katex-test--common-mathematical-symbols","pageTitle":"","sectionTitle":"✅ Common Mathematical Symbols","content":"Greek letters:  Relation symbols:  Set symbols:  Arrows:","url":"/en/docs\\test\\katex-test#common-mathematical-symbols","lang":"en","tokens":["common","mathematical","symbols","greek","letters","relation","set","arrows"]},{"id":"docs-test-katex-test--extreme-stress-test-very-important","pageTitle":"","sectionTitle":"🚨 Extreme Stress Test (Very Important)","content":"If this section renders correctly, it means KaTeX is basically fully functional","url":"/en/docs\\test\\katex-test#extreme-stress-test-very-important","lang":"en","tokens":["extreme","stress","test","very","important","if","this","section","renders","correctly","it","means","katex","is","basically","fully","functional"]},{"id":"docs-test-katex-test--rendering-checklist","pageTitle":"","sectionTitle":"✅ Rendering Checklist","content":"Inline formulas work correctly Block formulas are centered Matrix alignment is correct mhchem works correctly Physics macros work correctly Alignment environment works correctly No overflow on mobile Visible in dark mode","url":"/en/docs\\test\\katex-test#rendering-checklist","lang":"en","tokens":["rendering","checklist","inline","formulas","work","correctly","block","are","centered","matrix","alignment","is","correct","mhchem","works","physics","macros","environment","no","overflow","on","mobile","visible","in","dark","mode"]},{"id":"docs-test-katex-test--if-all-pass","pageTitle":"","sectionTitle":"🎉 If All Pass","content":"👉 Your KaTeX configuration is already complete","url":"/en/docs\\test\\katex-test#if-all-pass","lang":"en","tokens":["if","all","pass","your","katex","configuration","is","already","complete"]},{"id":"docs-test-mdx-test--mdx-component-usage-examples","pageTitle":"","sectionTitle":"MDX Component Usage Examples","content":"This page demonstrates how to use custom React components in Markdown documents.","url":"/en/docs\\test\\mdx-test#mdx-component-usage-examples","lang":"en","tokens":["mdx","component","usage","examples","this","page","demonstrates","how","to","use","custom","react","components","in","markdown","documents"]},{"id":"docs-test-mdx-test--using-built-in-components","pageTitle":"","sectionTitle":"Using Built-in Components","content":"react-docs-ui provides some built-in MDX components that can be used directly. Note : Component names support both PascalCase (recommended) and lowercase. For example, both <CodeBlock and <codeblock work correctly. <Tip title=\"This is a warning tip\" This is the content of a tip component. You can pl...","url":"/en/docs\\test\\mdx-test#using-built-in-components","lang":"en","tokens":["using","built","in","components","react","docs","ui","provides","some","mdx","that","can","be","used","directly","note","component","names","support","both","pascalcase","recommended","and","lowercase","for","example","codeblock","work","correctly","tip","title","this","is","a","warning","the","content","of","you","place","important","tips","here"]},{"id":"docs-test-mdx-test--using-custom-components","pageTitle":"","sectionTitle":"Using Custom Components","content":"React components created in the src/components directory of the template are automatically scanned and registered, and can be used directly in MDX documents:","url":"/en/docs\\test\\mdx-test#using-custom-components","lang":"en","tokens":["using","custom","components","react","created","in","the","src","directory","of","template","are","automatically","scanned","and","registered","can","be","used","directly","mdx","documents"]},{"id":"docs-test-mdx-test--alert-component","pageTitle":"","sectionTitle":"Alert Component","content":"The Alert component supports multiple types: info, success, warning, error","url":"/en/docs\\test\\mdx-test#alert-component","lang":"en","tokens":["alert","component","the","supports","multiple","types","info","success","warning","error"]},{"id":"docs-test-mdx-test--feature-component","pageTitle":"","sectionTitle":"Feature Component","content":"The Feature component is used to display feature highlights: <Feature icon=\"⚡\" title=\"Quick Start\" description=\"Start your project in seconds without complex configuration.\" <Feature icon=\"🎨\" title=\"Theme Customization\" description=\"Supports light and dark themes, fully customizable.\" <Feature icon...","url":"/en/docs\\test\\mdx-test#feature-component","lang":"en","tokens":["feature","component","the","is","used","to","display","highlights","icon","title","quick","start","description","your","project","in","seconds","without","complex","configuration","theme","customization","supports","light","and","dark","themes","fully","customizable","responsive","design","perfectly","adapts","various","devices","for","best","user","experience"]},{"id":"docs-test-mdx-test--callout-component","pageTitle":"","sectionTitle":"Callout Component","content":"The Callout component is used to emphasize important content:","url":"/en/docs\\test\\mdx-test#callout-component","lang":"en","tokens":["callout","component","the","is","used","to","emphasize","important","content"]},{"id":"docs-test-mdx-test--badgelist-component","pageTitle":"","sectionTitle":"BadgeList Component","content":"The BadgeList component is used to display tags or statuses:","url":"/en/docs\\test\\mdx-test#badgelist-component","lang":"en","tokens":["badgelist","component","the","is","used","to","display","tags","or","statuses"]},{"id":"docs-test-mdx-test--code-block-examples","pageTitle":"","sectionTitle":"Code Block Examples","content":"You can use standard Markdown code block syntax in MDX:","url":"/en/docs\\test\\mdx-test#code-block-examples","lang":"en","tokens":["code","block","examples","you","can","use","standard","markdown","syntax","in","mdx"]},{"id":"docs-test-test--document-rendering-test-page","pageTitle":"","sectionTitle":"📄 Document Rendering Test Page","content":"Used to test whether the documentation website correctly renders various Markdown / MDX features.","url":"/en/docs\\test\\test#document-rendering-test-page","lang":"en","tokens":["document","rendering","test","page","used","to","whether","the","documentation","website","correctly","renders","various","markdown","mdx","features"]},{"id":"docs-test-test--table-of-contents","pageTitle":"","sectionTitle":"🧭 Table of Contents","content":"Heading Test Text Styles Lists Code Blocks Tables Quote Blocks Callout Blocks Images Math Formulas MDX Components (Optional)","url":"/en/docs\\test\\test#table-of-contents","lang":"en","tokens":["table","of","contents","heading","test","text","styles","lists","code","blocks","tables","quote","callout","images","math","formulas","mdx","components","optional"]},{"id":"docs-test-test--text-styles","pageTitle":"","sectionTitle":"Text Styles","content":"Bold Italic Strikethrough Inline code Ctrl + C","url":"/en/docs\\test\\test#text-styles","lang":"en","tokens":["text","styles","bold","italic","strikethrough","inline","code","ctrl","c"]},{"id":"docs-test-test--unordered-list","pageTitle":"","sectionTitle":"Unordered List","content":"Apple Banana Sub-item 1 Sub-item 2 Orange","url":"/en/docs\\test\\test#unordered-list","lang":"en","tokens":["unordered","list","apple","banana","sub","item","1","2","orange"]},{"id":"docs-test-test--ordered-list","pageTitle":"","sectionTitle":"Ordered List","content":"First step Second step Third step","url":"/en/docs\\test\\test#ordered-list","lang":"en","tokens":["ordered","list","first","step","second","third"]},{"id":"docs-test-test--task-list","pageTitle":"","sectionTitle":"Task List","content":"Completed Not completed","url":"/en/docs\\test\\test#task-list","lang":"en","tokens":["task","list","completed","not"]},{"id":"docs-test-test--tables","pageTitle":"","sectionTitle":"Tables","content":"Feature Supported Notes Headings ✅ Normal Code Blocks ✅ Highlighted Math Formulas ⏳ Depends on theme","url":"/en/docs\\test\\test#tables","lang":"en","tokens":["tables","feature","supported","notes","headings","normal","code","blocks","highlighted","math","formulas","depends","on","theme"]},{"id":"docs-test-test--quote-blocks","pageTitle":"","sectionTitle":"Quote Blocks","content":"This is a quote block Used to test styles.","url":"/en/docs\\test\\test#quote-blocks","lang":"en","tokens":["quote","blocks","this","is","a","block","used","to","test","styles"]},{"id":"docs-test-test--callout-blocks","pageTitle":"","sectionTitle":"Callout Blocks","content":"[!NOTE] This is a NOTE callout block (some themes support it) [!TIP] This is a TIP callout block [!WARNING] This is a WARNING callout block","url":"/en/docs\\test\\test#callout-blocks","lang":"en","tokens":["callout","blocks","note","this","is","a","block","some","themes","support","it","tip","warning"]},{"id":"docs-test-test--images","pageTitle":"","sectionTitle":"Images","content":"","url":"/en/docs\\test\\test#images","lang":"en","tokens":["images"]},{"id":"docs-test-test--math-formulas","pageTitle":"","sectionTitle":"Math Formulas","content":"Inline formula:  Block formula:","url":"/en/docs\\test\\test#math-formulas","lang":"en","tokens":["math","formulas","inline","formula","block"]},{"id":"docs-test-test--mdx-components-optional","pageTitle":"","sectionTitle":"MDX Components (Optional)","content":"If your documentation system supports MDX, you can test:","url":"/en/docs\\test\\test#mdx-components-optional","lang":"en","tokens":["mdx","components","optional","if","your","documentation","system","supports","you","can","test"]},{"id":"docs-test-test--collapsible-block-some-themes-support","pageTitle":"","sectionTitle":"🔥 Collapsible Block (Some themes support)","content":"This is the collapsed content.","url":"/en/docs\\test\\test#collapsible-block-some-themes-support","lang":"en","tokens":["collapsible","block","some","themes","support","this","is","the","collapsed","content"]},{"id":"docs-test-test--long-content-scroll-test","pageTitle":"","sectionTitle":"🧪 Long Content Scroll Test","content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing e...","url":"/en/docs\\test\\test#long-content-scroll-test","lang":"en","tokens":["long","content","scroll","test","lorem","ipsum","dolor","sit","amet","consectetur","adipiscing","elit","sed","do","eiusmod","tempor","incididunt","ut","labore","et","dolore","magna","aliqua"]},{"id":"docs-test-test--rendering-checklist","pageTitle":"","sectionTitle":"✅ Rendering Checklist","content":"Code highlighting works correctly Table styles are correct Callout blocks have styles Math formulas work correctly Images are responsive Mobile responsive works correctly Test Completed 🎉 If you'd like, I can help you generate another one: 🔥 Specialized test version for Nextra 🚀 Specialized test ...","url":"/en/docs\\test\\test#rendering-checklist","lang":"en","tokens":["rendering","checklist","code","highlighting","works","correctly","table","styles","are","correct","callout","blocks","have","math","formulas","work","images","responsive","mobile","test","completed","if","you","d","like","i","can","help","generate","another","one","specialized","version","for","nextra","vitepress","extreme","stress","specifically","tests","break","just","let","me","know"]},{"id":"docs-test--documentation-tests","pageTitle":"","sectionTitle":"Documentation Tests","content":"This section contains various test pages to verify the rendering capabilities of React Docs UI.","url":"/en/docs\\test#documentation-tests","lang":"en","tokens":["documentation","tests","this","section","contains","various","test","pages","to","verify","the","rendering","capabilities","of","react","docs","ui"]},{"id":"docs-test--test-pages","pageTitle":"","sectionTitle":"Test Pages","content":"MD Test - Test various Markdown syntax and features KaTeX Test - Test complete mathematical formula functionality MDX Demo - View examples of MDX component usage","url":"/en/docs\\test#test-pages","lang":"en","tokens":["test","pages","md","various","markdown","syntax","and","features","katex","complete","mathematical","formula","functionality","mdx","demo","view","examples","of","component","usage"]},{"id":"docs--documentation","pageTitle":"","sectionTitle":"Documentation","content":"Welcome to the React Docs UI documentation system.","url":"/en/docs#documentation","lang":"en","tokens":["documentation","welcome","to","the","react","docs","ui","system"]},{"id":"docs--quick-start","pageTitle":"","sectionTitle":"Quick Start","content":"Introduction - Learn about the core philosophy of React Docs UI Installation - Learn how to install and configure Quick Start - Create your first documentation site in 5 minutes Configuration - Deep dive into configuration options PDF Server Deployment - Deploy PDF generation service","url":"/en/docs#quick-start","lang":"en","tokens":["quick","start","introduction","learn","about","the","core","philosophy","of","react","docs","ui","installation","how","to","install","and","configure","create","your","first","documentation","site","in","5","minutes","configuration","deep","dive","into","options","pdf","server","deployment","deploy","generation","service"]},{"id":"docs--documentation-tests","pageTitle":"","sectionTitle":"Documentation Tests","content":"MD Test - Test Markdown rendering functionality KaTeX Test - Test mathematical formula rendering MDX Demo - View MDX component usage examples","url":"/en/docs#documentation-tests","lang":"en","tokens":["documentation","tests","md","test","markdown","rendering","functionality","katex","mathematical","formula","mdx","demo","view","component","usage","examples"]},{"id":"index--react-docs-ui","pageTitle":"","sectionTitle":"React Docs UI","content":"A configuration-driven modern documentation website builder based on React. React Docs UI aims to make creating beautiful, powerful documentation websites simpler than ever. You just need to focus on writing Markdown documents, and everything else—from routing and navigation to theme switching and t...","url":"/en/index#react-docs-ui","lang":"en","tokens":["react","docs","ui","a","configuration","driven","modern","documentation","website","builder","based","on","aims","to","make","creating","beautiful","powerful","websites","simpler","than","ever","you","just","need","focus","writing","markdown","documents","and","everything","else","from","routing","navigation","theme","switching","the","command","menu","is","by","simple","yaml"]},{"id":"index--core-features","pageTitle":"","sectionTitle":"Core Features","content":"Configuration-Driven : Define your entire website via site.yaml without coding. Out-of-the-Box : Quickly start your project with all necessary features built-in. Modern Design : Elegant responsive layout with automatic light/dark theme switching. Command Menu : Built-in Cmd+K shortcut menu for quick...","url":"/en/index#core-features","lang":"en","tokens":["core","features","configuration","driven","define","your","entire","website","via","site","yaml","without","coding","out","of","the","box","quickly","start","project","with","all","necessary","built","in","modern","design","elegant","responsive","layout","automatic","light","dark","theme","switching","command","menu","cmd","k","shortcut","for","quick","page","access","markdown","support","full","gfm","and","frontmatter","internationalization","easily","implement","multi","language","through","files"]},{"id":"index--quick-start","pageTitle":"","sectionTitle":"Quick Start","content":"Get your own documentation website with just one command:","url":"/en/index#quick-start","lang":"en","tokens":["quick","start","get","your","own","documentation","website","with","just","one","command"]},{"id":"index--links","pageTitle":"","sectionTitle":"Links","content":"Guide : Start learning about all the features of React Docs UI. GitHub : View the source code, submit issues, or contribute.","url":"/en/index#links","lang":"en","tokens":["links","guide","start","learning","about","all","the","features","of","react","docs","ui","github","view","source","code","submit","issues","or","contribute"]}]}