create-react-docs-ui 0.6.6 → 0.6.8

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-react-docs-ui",
-    "version": "0.6.6",
+    "version": "0.6.8",
     "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.6",
+        "react-docs-ui": "^0.6.8",
         "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:
@@ -215,7 +227,7 @@ ai:
 
 # Fonts Configuration
 fonts:
-    fontFamilyZhCn: "PingFang SC, Microsoft YaHei, Noto Sans SC, sans-serif"
+    fontFamilyZhCn: "MiSans, PingFang SC, Noto Sans SC, Microsoft YaHei, sans-serif"
     fontFamilyEn: "Fragment Mono, system-ui, sans-serif"
 
 # Full-text Search Configuration

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:
@@ -214,7 +226,7 @@ ai:
 
 # 字体配置
 fonts:
-    fontFamilyZhCn: "PingFang SC, Microsoft YaHei, Noto Sans SC, sans-serif"
+    fontFamilyZhCn: "MiSans, PingFang SC, Noto Sans SC, Microsoft YaHei, sans-serif"
     fontFamilyEn: "Fragment Mono, system-ui, sans-serif"
 
 # 全文搜索配置

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

@@ -1 +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"]}]}
+{"version":"2.0.0","generatedAt":1773315775030,"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"]}]}

package/template/public/search-index-zh-cn.json

@@ -1 +1 @@
-{"version":"2.0.0","generatedAt":1773044368923,"lang":"zh-cn","sections":[{"id":"docs-guide-configuration--配置文件-site-yaml-字段说明","pageTitle":"","sectionTitle":"配置文件（ `site.yaml` ）字段说明","content":"项目遵循“配置驱动”。绝大多数行为由 public/config/site.yaml 决定。下面用表格逐项说明所有字段。","url":"/zh-cn/docs\\guide\\configuration#配置文件-site-yaml-字段说明","lang":"zh-cn","tokens":["配置","置文","文件","配","置","文","件","site","yaml","字段","段说","说明","字","段","说","明","项目","目遵","遵循","循“","“配","置驱","驱动","动”","项","目","遵","循","“","驱","动","”","绝大","大多","多数","数行","行为","为由","绝","大","多","数","行","为","由","public","config","决定","决","定","下面","面用","用表","表格","格逐","逐项","项说","明所","所有","有字","下","面","用","表","格","逐","所","有"]},{"id":"docs-guide-configuration--顶级键","pageTitle":"","sectionTitle":"顶级键","content":"键 作用 site 全局元信息（标题、描述、Logo、作者） navbar 顶部导航（开关、导航项、操作按钮） sidebar 左侧导航树（集合/分组/子项） theme 主题配置（默认模式、是否允许切换） toc 文章右侧目录（开关、层级、标题） footer 页脚（链接、社交、仓库信息） contextMenu 右键菜单配置 mdx MDX 组件配置 pwa PWA 设置（预留/可选）","url":"/zh-cn/docs\\guide\\configuration#顶级键","lang":"zh-cn","tokens":["顶级","级键","顶","级","键","作用","作","用","site","全局","局元","元信","信息","全","局","元","信","息","标题","标","题","描述","描","述","logo","作者","者","navbar","顶部","部导","导航","部","导","航","开关","开","关","航项","项","操作","作按","按钮","操","按","钮","sidebar","左侧","侧导","航树","左","侧","树","集合","合/","/分","分组","组/","/子","子项","集","合","/","分","组","子","theme","主题","题配","配置","主","配","置","默认","认模","模式","默","认","模","式","是否","否允","允许","许切","切换","是","否","允","许","切","换","toc","文章","章右","右侧","侧目","目录","文","章","右","目","录","层级","层","footer","页脚","页","脚","链接","链","接","社交","社","交","仓库","库信","仓","库","contextmenu","右键","键菜","菜单","单配","菜","单","mdx","组件","件配","件","pwa","设置","设","预留","留/","/可","可选","预","留","可","选"]},{"id":"docs-guide-configuration--site","pageTitle":"","sectionTitle":"`site`","content":"字段 类型 说明 示例 title string 网站标题 \"React Docs UI 示例\" description string 简短网站描述（SEO） \"简单漂亮的文档站\" logo string 或 object 网站 Logo。字符串可为 emoji 或图片路径；对象可分别设置亮/暗图标 \"📚\" 、 \"/images/logo.png\" 、或 { light: \"/images/favicon.svg\", dark: \"/images/favicon-dark.svg\" } author string 作者或组织 \"React Docs UI Team\" Logo 支持： Emo...","url":"/zh-cn/docs\\guide\\configuration#site","lang":"zh-cn","tokens":["site","字段","字","段","类型","类","型","说明","说","明","示例","示","例","title","string","网站","站标","标题","网","站","标","题","react","docs","ui","description","简短","短网","站描","描述","简","短","描","述","seo","简单","单漂","漂亮","亮的","的文","文档","档站","单","漂","亮","的","文","档","logo","或","object","字符","符串","串可","可为","符","串","可","为","emoji","或图","图片","片路","路径","图","片","路","径","对象","象可","可分","分别","别设","设置","置亮","亮/","/暗","暗图","图标","对","象","分","别","设","置","/","暗","images","png","light","favicon","svg","dark","author","作者","者或","或组","组织","作","者","组","织","team","支持","支","持","公共","共路","径或","公","共","url","明/","暗主","主题","题对","主"]},{"id":"docs-guide-configuration--navbar","pageTitle":"","sectionTitle":"`navbar`","content":"字段 类型 说明 showLogo boolean 是否显示左上角 Logo showTitle boolean 是否显示站点标题 showLanguageSwitcher boolean 是否显示语言切换 items array 主导航链接 actions array 右侧操作按钮（如 GitHub） Item 字段 类型 说明 示例 title string 链接文字 \"指南\" link string 路径或 URL。内部路径以 / 开头 \"/guide\" external boolean(可选) 外部链接新开标签 visible boolean(可选) 条件展示 Action 字段 类型...","url":"/zh-cn/docs\\guide\\configuration#navbar","lang":"zh-cn","tokens":["navbar","字段","字","段","类型","类","型","说明","说","明","showlogo","boolean","是否","否显","显示","示左","左上","上角","是","否","显","示","左","上","角","logo","showtitle","示站","站点","点标","标题","站","点","标","题","showlanguageswitcher","示语","语言","言切","切换","语","言","切","换","items","array","主导","导航","航链","链接","主","导","航","链","接","actions","右侧","侧操","操作","作按","按钮","右","侧","操","作","按","钮","如","github","item","示例","例","title","string","接文","文字","文","指南","指","南","link","路径","径或","路","径","或","url","内部","部路","径以","内","部","以","开头","开","头","guide","external","bo","oo","ol","le","ea","an","n(","(可","可选","选)","b","o","l","e","a","n","(","可","选",")","外部","部链","接新","新开","开标","标签","外","新","签","visible","条件","件展","展示","条","件","展","action","type","custom","预设","设或","或自","自定","定义","义动","动作","预","设","自","定","义","动","st","tr","ri","in","ng","g(","s","t","r","i","g","钮文","文案","案","目标","标链","目","icon","作图","图标","标名","图","名","enabled","否启","启用","启","用"]},{"id":"docs-guide-configuration--sidebar","pageTitle":"","sectionTitle":"`sidebar`","content":"字段 类型 说明 enabled boolean(可选) 全局开启/关闭侧边栏 collections record<string, Collection 顶级集合映射（如 guide ） sections Section[] (兼容，可选) 旧版单树结构 Collection 字段 类型 说明 sections Section[] 一组可折叠分组 Section 字段 类型 说明 示例 title string 分组标题 \"快速开始\" path string 访问该前缀将自动展开/高亮 \"/guide\" children Child 该分组下的子链接 Child 字段 类型 说明 示例 ti...","url":"/zh-cn/docs\\guide\\configuration#sidebar","lang":"zh-cn","tokens":["sidebar","字段","字","段","类型","类","型","说明","说","明","enabled","bo","oo","ol","le","ea","an","n(","(可","可选","选)","b","o","l","e","a","n","(","可","选",")","全局","局开","开启","启/","/关","关闭","闭侧","侧边","边栏","全","局","开","启","/","关","闭","侧","边","栏","collections","record","string","collection","顶级","级集","集合","合映","映射","顶","级","集","合","映","射","如","guide","sections","section","(兼","兼容","兼","容","旧版","版单","单树","树结","结构","旧","版","单","树","结","构","一组","组可","可折","折叠","叠分","分组","一","组","折","叠","分","示例","示","例","title","组标","标题","标","题","快速","速开","开始","快","速","始","path","访问","问该","该前","前缀","缀将","将自","自动","动展","展开","开/","/高","高亮","访","问","该","前","缀","将","自","动","展","高","亮","children","child","该分","组下","下的","的子","子链","链接","下","的","子","链","接","接文","文字","文","介绍","介","绍","完整","整页","页面","面路","路径","完","整","页","面","路","径","introduction"]},{"id":"docs-guide-configuration--theme","pageTitle":"","sectionTitle":"`theme`","content":"字段 类型 说明 可选值 默认值 defaultMode string 默认主题模式 light / dark / auto auto allowToggle boolean 是否允许用户切换主题 true / false true","url":"/zh-cn/docs\\guide\\configuration#theme","lang":"zh-cn","tokens":["theme","字段","字","段","类型","类","型","说明","说","明","可选","选值","可","选","值","默认","认值","默","认","defaultmode","string","认主","主题","题模","模式","主","题","模","式","light","dark","auto","allowtoggle","boolean","是否","否允","允许","许用","用户","户切","切换","换主","是","否","允","许","用","户","切","换","true","false"]},{"id":"docs-guide-configuration--toc","pageTitle":"","sectionTitle":"`toc`","content":"字段 类型 说明 示例 enabled boolean 是否启用页面目录 true maxLevel number (1-6) 展示的最大标题层级 3 title string 目录标题 \"本页内容\" 说明：具体锚点与是否显示也可能受页面 Frontmatter 影响。","url":"/zh-cn/docs\\guide\\configuration#toc","lang":"zh-cn","tokens":["toc","字段","字","段","类型","类","型","说明","说","明","示例","示","例","enabled","boolean","是否","否启","启用","用页","页面","面目","目录","是","否","启","用","页","面","目","录","true","maxlevel","number","1","6","展示","示的","的最","最大","大标","标题","题层","层级","展","的","最","大","标","题","层","级","3","title","string","录标","本页","页内","内容","本","内","容","具体","体锚","锚点","点与","与是","否显","显示","示也","也可","可能","能受","受页","具","体","锚","点","与","显","也","可","能","受","frontmatter","影响","影","响"]},{"id":"docs-guide-configuration--footer","pageTitle":"","sectionTitle":"`footer`","content":"字段 类型 说明 enabled boolean 是否显示页脚 copyright string 版权文案 repository Repository(可选) 仓库信息（如“在 GitHub 上编辑此页”） lastUpdated string(可选) 站点/内容最近更新时间 links Link 页脚链接列 social Social 社交图标链接 Repository 字段 类型 说明 示例 url string 仓库地址 \"https://github.com/user/repo\" branch string 文档所在分支 \"main\" Link 字段 类型 说明 title strin...","url":"/zh-cn/docs\\guide\\configuration#footer","lang":"zh-cn","tokens":["footer","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","是否","否显","显示","示页","页脚","是","否","显","示","页","脚","copyright","string","版权","权文","文案","版","权","文","案","repository","Re","ep","po","os","si","it","to","or","ry","y(","(可","可选","选)","R","e","p","o","s","i","t","r","y","(","可","选",")","仓库","库信","信息","仓","库","信","息","如“","“在","如","“","在","github","上编","编辑","辑此","此页","页”","上","编","辑","此","”","lastupdated","st","tr","ri","in","ng","g(","n","g","站点","点/","/内","内容","容最","最近","近更","更新","新时","时间","站","点","/","内","容","最","近","更","新","时","间","links","link","脚链","链接","接列","链","接","列","social","社交","交图","图标","标链","社","交","图","标","示例","例","url","库地","地址","地","址","https","com","user","repo","branch","文档","档所","所在","在分","分支","档","所","分","支","main","title","接标","标题","题","路径","径或","路","径","或","external","bo","oo","ol","le","ea","an","n(","b","l","a","新开","开标","标签","开","签","name","平台","台名","名称","平","台","名","称","twitter","bilibili","个人","人页","页或","或链","个","人","icon","标名"]},{"id":"docs-guide-configuration--contextmenu","pageTitle":"","sectionTitle":"`contextMenu`","content":"字段 类型 说明 enabled boolean 全局开关，false 则完全禁用右键菜单 page object 页面组菜单项配置 site object 站点组菜单项配置 appearance object 外观组菜单项配置 Page 字段 类型 说明 默认值 copySelectedText boolean 复制选中的文字 true copyUrl boolean 复制当前链接 true copyTitle boolean 复制页面标题 false copyMarkdownLink boolean 复制 Markdown 链接 false openInNewTab boolean 在新标...","url":"/zh-cn/docs\\guide\\configuration#contextmenu","lang":"zh-cn","tokens":["contextmenu","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","全局","局开","开关","全","局","开","关","false","则完","完全","全禁","禁用","用右","右键","键菜","菜单","则","完","禁","用","右","键","菜","单","page","object","页面","面组","组菜","单项","项配","配置","页","面","组","项","配","置","site","站点","点组","站","点","appearance","外观","观组","外","观","默认","认值","默","认","值","copyselectedtext","复制","制选","选中","中的","的文","文字","复","制","选","中","的","文","true","copyurl","制当","当前","前链","链接","当","前","链","接","copytitle","制页","面标","标题","标","题","copymarkdownlink","markdown","openinnewtab","在新","新标","标签","签页","页打","打开","在","新","签","打","reload","刷新","刷","printpage","打印","印页","印","scrolltotop","回到","到顶","顶部","回","到","顶","部","scrolltobottom","滚动","动到","到底","底部","滚","动","底","gohome","返回","回首","首页","返","首","quicknav","快速","速跳","跳转","快","速","跳","转","language","语言","言切","切换","语","言","切","换","theme","主题","题切","主","resetthemepref","重置","置主","题偏","偏好","重","偏","好"]},{"id":"docs-guide-configuration--mdx","pageTitle":"","sectionTitle":"`mdx`","content":"字段 类型 说明 示例 componentsPath string 组件扫描路径 \"/src/components\" enabled boolean 启用 MDX 支持 true","url":"/zh-cn/docs\\guide\\configuration#mdx","lang":"zh-cn","tokens":["mdx","字段","字","段","类型","类","型","说明","说","明","示例","示","例","componentspath","string","组件","件扫","扫描","描路","路径","组","件","扫","描","路","径","src","components","enabled","boolean","启用","启","用","支持","支","持","true"]},{"id":"docs-guide-configuration--pwa-可选","pageTitle":"","sectionTitle":"`pwa` （可选）","content":"字段 类型 说明 enabled boolean 是否启用 PWA（预留） name string 应用名 shortName string 应用短名 description string 应用描述 themeColor string 主题色 backgroundColor string 背景色","url":"/zh-cn/docs\\guide\\configuration#pwa-可选","lang":"zh-cn","tokens":["pwa","可选","可","选","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","是否","否启","启用","是","否","启","用","预留","预","留","name","string","应用","用名","应","名","shortname","用短","短名","短","description","用描","描述","描","述","themecolor","主题","题色","主","题","色","backgroundcolor","背景","景色","背","景"]},{"id":"docs-guide-installation--环境要求","pageTitle":"","sectionTitle":"环境要求","content":"在开始之前，请确保你的开发环境满足以下要求： Node.js : 版本 = 18.0.0 包管理器 : npm , yarn 或 pnpm","url":"/zh-cn/docs\\guide\\installation#环境要求","lang":"zh-cn","tokens":["环境","境要","要求","环","境","要","求","在开","开始","始之","之前","在","开","始","之","前","请确","确保","保你","你的","的开","开发","发环","境满","满足","足以","以下","下要","请","确","保","你","的","发","满","足","以","下","node","js","版本","版","本","18","0","包管","管理","理器","包","管","理","器","npm","yarn","或","pnpm"]},{"id":"docs-guide-installation--推荐方式-使用脚手架","pageTitle":"","sectionTitle":"推荐方式：使用脚手架","content":"我们强烈推荐使用官方的 create-react-docs-ui 脚手架来创建你的新文档项目。这是最快、最简单的方式，可以确保所有配置都已就绪。 运行创建命令 : 这会在当前目录下创建一个名为 my-docs 的新文件夹。 进入项目并安装依赖 : 启动开发服务器 : 现在，你的文档网站已经运行在 http://localhost:5173 (或另一个可用端口) 上了。","url":"/zh-cn/docs\\guide\\installation#推荐方式-使用脚手架","lang":"zh-cn","tokens":["推荐","荐方","方式","推","荐","方","式","使用","用脚","脚手","手架","使","用","脚","手","架","我们","们强","强烈","烈推","荐使","用官","官方","方的","我","们","强","烈","官","的","create","react","docs","ui","架来","来创","创建","建你","你的","的新","新文","文档","档项","项目","来","创","建","你","新","文","档","项","目","这是","是最","最快","这","是","最","快","最简","简单","单的","的方","简","单","可以","以确","确保","保所","所有","有配","配置","置都","都已","已就","就绪","可","以","确","保","所","有","配","置","都","已","就","绪","运行","行创","建命","命令","运","行","命","令","这会","会在","在当","当前","前目","目录","录下","下创","建一","一个","个名","名为","会","在","当","前","录","下","一","个","名","为","my","文件","件夹","件","夹","进入","入项","目并","并安","安装","装依","依赖","进","入","并","安","装","依","赖","启动","动开","开发","发服","服务","务器","启","动","开","发","服","务","器","现在","现","的文","档网","网站","站已","已经","经运","行在","网","站","经","http","localhost","5173","(或","或另","另一","个可","可用","用端","端口","口)","(","或","另","端","口",")","上了","上","了"]},{"id":"docs-guide-installation--手动安装-适用于现有项目","pageTitle":"","sectionTitle":"手动安装 (适用于现有项目)","content":"如果你想在已有的 Vite + React 项目中手动集成 react-docs-ui ，可以按照以下步骤操作： 安装核心库 : 创建配置文件 : 在你的 public 目录下创建一个 config 文件夹，并在其中新建一个 site.yaml 文件。你可以从 这里 复制一个基础模板。 创建文档目录 : 在 public 目录下创建一个 docs 文件夹，用于存放你的 Markdown 文件。例如: public/docs/zh-cn/index.md 。 修改应用入口文件 : 更新你的 src/main.tsx (或 main.jsx ) 文件，渲染 DocsApp 组件来初始化应用。 确保...","url":"/zh-cn/docs\\guide\\installation#手动安装-适用于现有项目","lang":"zh-cn","tokens":["手动","动安","安装","手","动","安","装","(适","适用","用于","于现","现有","有项","项目","目)","(","适","用","于","现","有","项","目",")","如果","果你","你想","想在","在已","已有","有的","如","果","你","想","在","已","的","vite","react","目中","中手","动集","集成","中","集","成","docs","ui","可以","以按","按照","照以","以下","下步","步骤","骤操","操作","可","以","按","照","下","步","骤","操","作","装核","核心","心库","核","心","库","创建","建配","配置","置文","文件","创","建","配","置","文","件","在你","你的","public","目录","录下","下创","建一","一个","录","一","个","config","件夹","夹","并在","在其","其中","中新","新建","并","其","新","site","yaml","你可","以从","从","这里","这","里","复制","制一","个基","基础","础模","模板","复","制","基","础","模","板","建文","文档","档目","档","于存","存放","放你","存","放","markdown","例如","如:","例",":","zh","cn","index","md","修改","改应","应用","用入","入口","口文","修","改","应","入","口","更新","新你","更","src","main","tsx","(或","或","jsx","渲染","渲","染","docsapp","组件","件来","来初","初始","始化","化应","组","来","初","始","化","确保","确","保","html","中有","div","id","root"]},{"id":"docs-guide-introduction--介绍","pageTitle":"","sectionTitle":"介绍","content":"React Docs UI 是一个专为构建现代化文档网站而设计的 React 组件库与工具集。它的核心哲学是 配置优于编码 ，让你能将精力完全集中在内容创作上。","url":"/zh-cn/docs\\guide\\introduction#介绍","lang":"zh-cn","tokens":["介绍","介","绍","react","docs","ui","是一","一个","个专","专为","为构","构建","建现","现代","代化","化文","文档","档网","网站","站而","而设","设计","计的","是","一","个","专","为","构","建","现","代","化","文","档","网","站","而","设","计","的","组件","件库","库与","与工","工具","具集","组","件","库","与","工","具","集","它的","的核","核心","心哲","哲学","学是","它","核","心","哲","学","配置","置优","优于","于编","编码","配","置","优","于","编","码","让你","你能","能将","将精","精力","力完","完全","全集","集中","中在","在内","内容","容创","创作","作上","让","你","能","将","精","力","完","全","中","在","内","容","创","作","上"]},{"id":"docs-guide-introduction--核心优势","pageTitle":"","sectionTitle":"核心优势","content":"配置驱动 : 这是 React Docs UI 最核心的特性。你不需要编写复杂的 React 组件或路由逻辑，只需维护一个清晰的 site.yaml 文件，就能定义网站的导航、侧边栏、主题、页脚等所有内容。 功能完备 : 开箱即用，提供了现代文档网站所需的一切： 响应式布局 明暗主题切换 基于 Markdown 的内容渲染 (支持 GFM 和 Frontmatter) 内置代码语法高亮 快捷命令菜单 (Cmd+K) 国际化支持 极简上手 : 通过官方的 create-react-docs-ui 脚手架，你可以在一分钟内启动一个功能齐全的文档网站，无需任何复杂的环境配置。 高度可定制 : 虽然开...","url":"/zh-cn/docs\\guide\\introduction#核心优势","lang":"zh-cn","tokens":["核心","心优","优势","核","心","优","势","配置","置驱","驱动","配","置","驱","动","这是","这","是","react","docs","ui","最核","心的","的特","特性","最","的","特","性","你不","不需","需要","要编","编写","写复","复杂","杂的","你","不","需","要","编","写","复","杂","组件","件或","或路","路由","由逻","逻辑","组","件","或","路","由","逻","辑","只需","需维","维护","护一","一个","个清","清晰","晰的","只","维","护","一","个","清","晰","site","yaml","文件","文","就能","能定","定义","义网","网站","站的","的导","导航","就","能","定","义","网","站","导","航","侧边","边栏","侧","边","栏","主题","主","题","页脚","脚等","等所","所有","有内","内容","页","脚","等","所","有","内","容","功能","能完","完备","功","完","备","开箱","箱即","即用","开","箱","即","用","提供","供了","了现","现代","代文","文档","档网","站所","所需","需的","的一","一切","提","供","了","现","代","档","切","响应","应式","式布","布局","响","应","式","布","局","明暗","暗主","题切","切换","明","暗","换","基于","基","于","markdown","的内","容渲","渲染","渲","染","(支","支持","(","支","持","gfm","和","frontmatter","内置","置代","代码","码语","语法","法高","高亮","码","语","法","高","亮","快捷","捷命","命令","令菜","菜单","快","捷","命","令","菜","单","cmd","k","国际","际化","化支","国","际","化","极简","简上","上手","极","简","上","手","通过","过官","官方","方的","通","过","官","方","create","脚手","手架","架","你可","可以","以在","在一","一分","分钟","钟内","内启","启动","动一","个功","能齐","齐全","全的","的文","可","以","在","分","钟","启","齐","全","无需","需任","任何","何复","的环","环境","境配","无","任","何","环","境","高度","度可","可定","定制","度","制","虽然","然开","虽","然","但每","每个","个部","部分","但","每","部","如","logo","配色","色","航链","链接","链","接","社交","交媒","媒体","体图","图标","标等","社","交","媒","体","图","标","都可","以通","过配","置文","件进","进行","行深","深度","度定","都","进","行","深"]},{"id":"docs-guide-introduction--适用场景","pageTitle":"","sectionTitle":"适用场景","content":"无论你是个人开发者还是团队，React Docs UI 都非常适合以下场景： 开源项目文档 : 为你的 React 项目提供一个专业、易于维护的文档网站。 产品手册 : 清晰地展示你的产品功能和使用指南。 团队知识库 : 在团队内部沉淀和分享基于 React 技术的知识。 个人博客或作品集 : 以优雅的方式组织和展示你的技术文章或项目。","url":"/zh-cn/docs\\guide\\introduction#适用场景","lang":"zh-cn","tokens":["适用","用场","场景","适","用","场","景","无论","论你","你是","是个","个人","人开","开发","发者","者还","还是","是团","团队","无","论","你","是","个","人","开","发","者","还","团","队","react","docs","ui","都非","非常","常适","适合","合以","以下","下场","都","非","常","合","以","下","开源","源项","项目","目文","文档","源","项","目","文","档","为你","你的","为","的","目提","提供","供一","一个","个专","专业","提","供","一","专","业","易于","于维","维护","护的","的文","档网","网站","易","于","维","护","网","站","产品","品手","手册","产","品","手","册","清晰","晰地","地展","展示","示你","的产","品功","功能","能和","和使","使用","用指","指南","清","晰","地","展","示","功","能","和","使","指","南","队知","知识","识库","知","识","库","在团","队内","内部","部沉","沉淀","淀和","和分","分享","享基","基于","在","内","部","沉","淀","分","享","基","技术","术的","的知","技","术","人博","博客","客或","或作","作品","品集","博","客","或","作","集","以优","优雅","雅的","的方","方式","式组","组织","织和","和展","的技","术文","文章","章或","或项","优","雅","方","式","组","织","章"]},{"id":"docs-guide-pdf-server--pdf-server-部署","pageTitle":"","sectionTitle":"PDF Server 部署","content":"React Docs UI 提供了 PDF 生成服务，可以独立部署为 Docker 容器。","url":"/zh-cn/docs\\guide\\pdf-server#pdf-server-部署","lang":"zh-cn","tokens":["pdf","server","部署","部","署","react","docs","ui","提供","供了","提","供","了","生成","成服","服务","生","成","服","务","可以","以独","独立","立部","署为","可","以","独","立","为","docker","容器","容","器"]},{"id":"docs-guide-pdf-server--使用-docker-compose","pageTitle":"","sectionTitle":"使用 Docker Compose","content":"创建 docker-compose.yml 文件： 启动服务：","url":"/zh-cn/docs\\guide\\pdf-server#使用-docker-compose","lang":"zh-cn","tokens":["使用","使","用","docker","compose","创建","创","建","yml","文件","文","件","启动","动服","服务","启","动","服","务"]},{"id":"docs-guide-pdf-server--api-接口","pageTitle":"","sectionTitle":"API 接口","content":"端点 方法 说明 /health GET 健康检查 /generate-pdf POST 生成 PDF（返回文件） /generate-pdf-sync POST 生成 PDF（返回 Base64）","url":"/zh-cn/docs\\guide\\pdf-server#api-接口","lang":"zh-cn","tokens":["api","接口","接","口","端点","端","点","方法","方","法","说明","说","明","health","get","健康","康检","检查","健","康","检","查","generate","pdf","post","生成","生","成","返回","回文","文件","返","回","文","件","sync","base64"]},{"id":"docs-guide-pdf-server--资源配置","pageTitle":"","sectionTitle":"资源配置","content":"PDF Server 基于 Puppeteer/Chromium 运行，建议配置： 场景 推荐内存 低并发（1-2 请求） 512MB 中等并发 1GB 高并发 2GB+","url":"/zh-cn/docs\\guide\\pdf-server#资源配置","lang":"zh-cn","tokens":["资源","源配","配置","资","源","配","置","pdf","server","基于","基","于","puppeteer","chromium","运行","运","行","建议","议配","建","议","场景","场","景","推荐","荐内","内存","推","荐","内","存","低并","并发","低","并","发","1","2","请求","请","求","512mb","中等","等并","中","等","1gb","高并","高","2gb"]},{"id":"docs-guide-pdf-server--环境变量","pageTitle":"","sectionTitle":"环境变量","content":"变量 默认值 说明 PDFSERVERPORT 3001 服务端口（Docker 镜像默认 6965）","url":"/zh-cn/docs\\guide\\pdf-server#环境变量","lang":"zh-cn","tokens":["环境","境变","变量","环","境","变","量","默认","认值","默","认","值","说明","说","明","pdfserverport","3001","服务","务端","端口","服","务","端","口","docker","镜像","像默","镜","像","6965"]},{"id":"docs-guide-quick-start--快速上手","pageTitle":"","sectionTitle":"快速上手","content":"本指南将引导你在 5 分钟内，从零开始创建、配置并运行一个属于你自己的 React 文档网站。","url":"/zh-cn/docs\\guide\\quick-start#快速上手","lang":"zh-cn","tokens":["快速","速上","上手","快","速","上","手","本指","指南","南将","将引","引导","导你","你在","本","指","南","将","引","导","你","在","5","分钟","钟内","分","钟","内","从零","零开","开始","始创","创建","从","零","开","始","创","建","配置","置并","并运","运行","行一","一个","个属","属于","于你","你自","自己","己的","配","置","并","运","行","一","个","属","于","自","己","的","react","文档","档网","网站","文","档","网","站"]},{"id":"docs-guide-quick-start--1-创建项目","pageTitle":"","sectionTitle":"1. 创建项目","content":"使用官方脚手架是最高效的方式。打开你的终端，运行以下命令： 然后，进入项目目录并安装依赖：","url":"/zh-cn/docs\\guide\\quick-start#1-创建项目","lang":"zh-cn","tokens":["1","创建","建项","项目","创","建","项","目","使用","用官","官方","方脚","脚手","手架","架是","是最","最高","高效","效的","的方","方式","使","用","官","方","脚","手","架","是","最","高","效","的","式","打开","开你","你的","的终","终端","打","开","你","终","端","运行","行以","以下","下命","命令","运","行","以","下","命","令","然后","然","后","进入","入项","目目","目录","录并","并安","安装","装依","依赖","进","入","录","并","安","装","依","赖"]},{"id":"docs-guide-quick-start--2-组织你的文档","pageTitle":"","sectionTitle":"2. 组织你的文档","content":"所有的文档内容都以 Markdown 文件的形式存放在 public/docs/ 目录下。 打开 public/docs/zh-cn/ 目录。 你可以修改现有的 index.md 和 guide 目录下的文件，或者创建新的 .md 文件。 例如，我们来创建一个新页面。在 public/docs/zh-cn/ 新建 about 目录以及 about.md 文件 , about.md 的内容如下","url":"/zh-cn/docs\\guide\\quick-start#2-组织你的文档","lang":"zh-cn","tokens":["2","组织","织你","你的","的文","文档","组","织","你","的","文","档","所有","有的","档内","内容","容都","都以","所","有","内","容","都","以","markdown","文件","件的","的形","形式","式存","存放","放在","件","形","式","存","放","在","public","docs","目录","录下","目","录","下","打开","打","开","zh","cn","你可","可以","以修","修改","改现","现有","可","修","改","现","index","md","和","guide","下的","或者","者创","创建","建新","新的","或","者","创","建","新","例如","例","如","我们","们来","来创","建一","一个","个新","新页","页面","我","们","来","一","个","页","面","新建","about","录以","以及","及","的内","容如","如下"]},{"id":"docs-guide-quick-start--3-配置网站","pageTitle":"","sectionTitle":"3. 配置网站","content":"现在，让我们通过修改配置文件来展示新创建的页面。 打开核心配置文件 public/config/site.yaml 。","url":"/zh-cn/docs\\guide\\quick-start#3-配置网站","lang":"zh-cn","tokens":["3","配置","置网","网站","配","置","网","站","现在","现","在","让我","我们","们通","通过","过修","修改","改配","置文","文件","件来","来展","展示","示新","新创","创建","建的","的页","页面","让","我","们","通","过","修","改","文","件","来","展","示","新","创","建","的","页","面","打开","开核","核心","心配","打","开","核","心","public","config","site","yaml"]},{"id":"docs-guide-quick-start--a-修改网站信息","pageTitle":"","sectionTitle":"a. 修改网站信息","content":"更新 site 部分，给你的网站一个新标题和 Logo。","url":"/zh-cn/docs\\guide\\quick-start#a-修改网站信息","lang":"zh-cn","tokens":["a","修改","改网","网站","站信","信息","修","改","网","站","信","息","更新","更","新","site","部分","部","分","给你","你的","的网","站一","一个","个新","新标","标题","题和","给","你","的","一","个","标","题","和","logo"]},{"id":"docs-guide-quick-start--b-添加到导航栏","pageTitle":"","sectionTitle":"b. 添加到导航栏","content":"在 navbar.items 数组中，为“关于”页面添加一个链接。","url":"/zh-cn/docs\\guide\\quick-start#b-添加到导航栏","lang":"zh-cn","tokens":["b","添加","加到","到导","导航","航栏","添","加","到","导","航","栏","在","navbar","items","数组","组中","数","组","中","为“","“关","关于","于”","”页","页面","面添","加一","一个","个链","链接","为","“","关","于","”","页","面","一","个","链","接"]},{"id":"docs-guide-quick-start--c-添加到侧边栏","pageTitle":"","sectionTitle":"c. 添加到侧边栏","content":"为了让“关于”页面在侧边栏也可见，我们在 新建一个 sidebar.collections.about.sections ，并且添加一个新条目。 这里侧边栏的about项还需要再创建一个文件 public/docs/zh-cn/about 下 创建about.md","url":"/zh-cn/docs\\guide\\quick-start#c-添加到侧边栏","lang":"zh-cn","tokens":["c","添加","加到","到侧","侧边","边栏","添","加","到","侧","边","栏","为了","了让","让“","“关","关于","于”","”页","页面","面在","在侧","栏也","也可","可见","为","了","让","“","关","于","”","页","面","在","也","可","见","我们","们在","我","们","新建","建一","一个","新","建","一","个","sidebar","collections","about","sections","并且","且添","加一","个新","新条","条目","并","且","条","目","这里","里侧","栏的","的a","ab","bo","ou","ut","t项","项还","还需","需要","要再","再创","创建","个文","文件","这","里","的","a","b","o","u","t","项","还","需","要","再","创","文","件","public","docs","zh","cn","下","建a","t.",".m","md",".","m","d"]},{"id":"docs-guide-quick-start--4-启动网站","pageTitle":"","sectionTitle":"4. 启动网站","content":"保存你的所有修改，然后在终端运行： 你的网站现在应该运行在 http://localhost:5173 上了。访问它，你会看到更新后的标题、Logo，以及导航栏和侧边栏中新增的“关于”链接。恭喜你，你已经成功掌握了 React Docs UI 的基本工作流程！","url":"/zh-cn/docs\\guide\\quick-start#4-启动网站","lang":"zh-cn","tokens":["4","启动","动网","网站","启","动","网","站","保存","存你","你的","的所","所有","有修","修改","保","存","你","的","所","有","修","改","然后","后在","在终","终端","端运","运行","然","后","在","终","端","运","行","的网","站现","现在","在应","应该","该运","行在","现","应","该","http","localhost","5173","上了","上","了","访问","问它","访","问","它","你会","会看","看到","到更","更新","新后","后的","的标","标题","会","看","到","更","新","标","题","logo","以及","及导","导航","航栏","栏和","和侧","侧边","边栏","栏中","中新","新增","增的","的“","“关","关于","于”","”链","链接","以","及","导","航","栏","和","侧","边","中","增","“","关","于","”","链","接","恭喜","喜你","恭","喜","你已","已经","经成","成功","功掌","掌握","握了","已","经","成","功","掌","握","react","docs","ui","的基","基本","本工","工作","作流","流程","基","本","工","作","流","程"]},{"id":"docs-guide--指南","pageTitle":"","sectionTitle":"指南","content":"本指南将帮助你全面了解并掌握 React Docs UI 的各项功能。无论你是初学者还是希望进行深度定制，都能在这里找到所需的信息。","url":"/zh-cn/docs\\guide#指南","lang":"zh-cn","tokens":["指南","指","南","本指","南将","将帮","帮助","助你","你全","全面","面了","了解","解并","并掌","掌握","本","将","帮","助","你","全","面","了","解","并","掌","握","react","docs","ui","的各","各项","项功","功能","的","各","项","功","能","无论","论你","你是","是初","初学","学者","者还","还是","是希","希望","望进","进行","行深","深度","度定","定制","无","论","是","初","学","者","还","希","望","进","行","深","度","定","制","都能","能在","在这","这里","里找","找到","到所","所需","需的","的信","信息","都","在","这","里","找","到","所","需","信","息"]},{"id":"docs-guide--目录","pageTitle":"","sectionTitle":"目录","content":"介绍 : 了解 React Docs UI 的核心理念和主要优势。 安装 : 学习如何通过脚手架或手动方式安装。 快速上手 : 在 5 分钟内创建并运行你的第一个文档网站。 配置说明 ( site.yaml ) : 深入了解每个配置项，完全掌控你的网站。","url":"/zh-cn/docs\\guide#目录","lang":"zh-cn","tokens":["目录","目","录","介绍","介","绍","了解","了","解","react","docs","ui","的核","核心","心理","理念","念和","和主","主要","要优","优势","的","核","心","理","念","和","主","要","优","势","安装","安","装","学习","习如","如何","何通","通过","过脚","脚手","手架","架或","或手","手动","动方","方式","式安","学","习","如","何","通","过","脚","手","架","或","动","方","式","快速","速上","上手","快","速","上","在","5","分钟","钟内","内创","创建","建并","并运","运行","行你","你的","的第","第一","一个","个文","文档","档网","网站","分","钟","内","创","建","并","运","行","你","第","一","个","文","档","网","站","配置","置说","说明","配","置","说","明","site","yaml","深入","入了","解每","每个","个配","置项","深","入","每","项","完全","全掌","掌控","控你","的网","完","全","掌","控"]},{"id":"docs-test-frontmatter-test--frontmatter-功能测试","pageTitle":"Frontmatter 测试页面","sectionTitle":"Frontmatter 功能测试","content":"这个页面用于测试 Frontmatter 字段的展示功能。","url":"/zh-cn/docs\\test\\frontmatter-test#frontmatter-功能测试","lang":"zh-cn","tokens":["frontmatter","功能","能测","测试","功","能","测","试","这个","个页","页面","面用","用于","于测","这","个","页","面","用","于","字段","段的","的展","展示","示功","字","段","的","展","示"]},{"id":"docs-test-frontmatter-test--测试说明","pageTitle":"Frontmatter 测试页面","sectionTitle":"测试说明","content":"如果你能看到页面上方的标题、描述、作者和日期信息，说明 Frontmatter 展示功能正常工作。","url":"/zh-cn/docs\\test\\frontmatter-test#测试说明","lang":"zh-cn","tokens":["测试","试说","说明","测","试","说","明","如果","果你","你能","能看","看到","到页","页面","面上","上方","方的","的标","标题","如","果","你","能","看","到","页","面","上","方","的","标","题","描述","描","述","作者","者和","和日","日期","期信","信息","作","者","和","日","期","信","息","frontmatter","展示","示功","功能","能正","正常","常工","工作","展","示","功","正","常","工"]},{"id":"docs-test-frontmatter-test--支持的字段","pageTitle":"Frontmatter 测试页面","sectionTitle":"支持的字段","content":"字段 说明 title 页面标题，会显示在内容区顶部，并设置为浏览器标签页标题 description 页面描述，显示在标题下方 author 作者信息，显示在描述下方 date 发布日期，显示在作者旁边","url":"/zh-cn/docs\\test\\frontmatter-test#支持的字段","lang":"zh-cn","tokens":["支持","持的","的字","字段","支","持","的","字","段","说明","说","明","title","页面","面标","标题","页","面","标","题","会显","显示","示在","在内","内容","容区","区顶","顶部","会","显","示","在","内","容","区","顶","部","并设","设置","置为","为浏","浏览","览器","器标","标签","签页","页标","并","设","置","为","浏","览","器","签","description","面描","描述","描","述","在标","题下","下方","下","方","author","作者","者信","信息","作","者","信","息","在描","述下","date","发布","布日","日期","发","布","日","期","在作","者旁","旁边","旁","边"]},{"id":"docs-test-frontmatter-test--普通内容","pageTitle":"Frontmatter 测试页面","sectionTitle":"普通内容","content":"这里是普通的 Markdown 内容，会正常渲染。 列表项 1 列表项 2 列表项 3 代码块测试： 测试完成 ✅","url":"/zh-cn/docs\\test\\frontmatter-test#普通内容","lang":"zh-cn","tokens":["普通","通内","内容","普","通","内","容","这里","里是","是普","通的","这","里","是","的","markdown","会正","正常","常渲","渲染","会","正","常","渲","染","列表","表项","列","表","项","1","2","3","代码","码块","块测","测试","代","码","块","测","试","试完","完成","完","成"]},{"id":"docs-test-katex-test--katex-全功能测试","pageTitle":"","sectionTitle":"🧪 KaTeX 全功能测试","content":"用于验证 KaTeX 是否正确加载所有扩展（mhchem / physics / mathtools 等）","url":"/zh-cn/docs\\test\\katex-test#katex-全功能测试","lang":"zh-cn","tokens":["katex","全功","功能","能测","测试","全","功","能","测","试","用于","于验","验证","用","于","验","证","是否","否正","正确","确加","加载","载所","所有","有扩","扩展","是","否","正","确","加","载","所","有","扩","展","mhchem","physics","mathtools","等"]},{"id":"docs-test-katex-test--行内公式","pageTitle":"","sectionTitle":"✅ 行内公式","content":"爱因斯坦质能方程：  欧拉公式：  分数测试：  根号测试：","url":"/zh-cn/docs\\test\\katex-test#行内公式","lang":"zh-cn","tokens":["行内","内公","公式","行","内","公","式","爱因","因斯","斯坦","坦质","质能","能方","方程","爱","因","斯","坦","质","能","方","程","欧拉","拉公","欧","拉","分数","数测","测试","分","数","测","试","根号","号测","根","号"]},{"id":"docs-test-katex-test--块级公式","pageTitle":"","sectionTitle":"✅ 块级公式","content":"","url":"/zh-cn/docs\\test\\katex-test#块级公式","lang":"zh-cn","tokens":["块级","级公","公式","块","级","公","式"]},{"id":"docs-test-katex-test--基础矩阵","pageTitle":"","sectionTitle":"基础矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#基础矩阵","lang":"zh-cn","tokens":["基础","础矩","矩阵","基","础","矩","阵"]},{"id":"docs-test-katex-test--括号矩阵","pageTitle":"","sectionTitle":"括号矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#括号矩阵","lang":"zh-cn","tokens":["括号","号矩","矩阵","括","号","矩","阵"]},{"id":"docs-test-katex-test--方括号矩阵","pageTitle":"","sectionTitle":"方括号矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#方括号矩阵","lang":"zh-cn","tokens":["方括","括号","号矩","矩阵","方","括","号","矩","阵"]},{"id":"docs-test-katex-test--行列式","pageTitle":"","sectionTitle":"行列式","content":"","url":"/zh-cn/docs\\test\\katex-test#行列式","lang":"zh-cn","tokens":["行列","列式","行","列","式"]},{"id":"docs-test-katex-test--对齐环境-ams","pageTitle":"","sectionTitle":"✅ 对齐环境（ams）","content":"","url":"/zh-cn/docs\\test\\katex-test#对齐环境-ams","lang":"zh-cn","tokens":["对齐","齐环","环境","对","齐","环","境","ams"]},{"id":"docs-test-katex-test--分段函数","pageTitle":"","sectionTitle":"✅ 分段函数","content":"","url":"/zh-cn/docs\\test\\katex-test#分段函数","lang":"zh-cn","tokens":["分段","段函","函数","分","段","函","数"]},{"id":"docs-test-katex-test--化学公式-mhchem","pageTitle":"","sectionTitle":"✅ 化学公式（mhchem）","content":"水：  燃烧反应：  可逆反应：  离子：","url":"/zh-cn/docs\\test\\katex-test#化学公式-mhchem","lang":"zh-cn","tokens":["化学","学公","公式","化","学","公","式","mhchem","水","燃烧","烧反","反应","燃","烧","反","应","可逆","逆反","可","逆","离子","离","子"]},{"id":"docs-test-katex-test--physics-宏测试","pageTitle":"","sectionTitle":"✅ physics 宏测试","content":"导数：  偏导：  二阶导：  绝对值：  范数：  期望值：  括号自动伸缩：","url":"/zh-cn/docs\\test\\katex-test#physics-宏测试","lang":"zh-cn","tokens":["physics","宏测","测试","宏","测","试","导数","导","数","偏导","偏","二阶","阶导","二","阶","绝对","对值","绝","对","值","范数","范","期望","望值","期","望","括号","号自","自动","动伸","伸缩","括","号","自","动","伸","缩"]},{"id":"docs-test-katex-test--mathtools-扩展","pageTitle":"","sectionTitle":"✅ mathtools 扩展","content":"多行对齐：  带标签：","url":"/zh-cn/docs\\test\\katex-test#mathtools-扩展","lang":"zh-cn","tokens":["mathtools","扩展","扩","展","多行","行对","对齐","多","行","对","齐","带标","标签","带","标","签"]},{"id":"docs-test-katex-test--常用数学符号","pageTitle":"","sectionTitle":"✅ 常用数学符号","content":"希腊字母：  关系符号：  集合符号：  箭头：","url":"/zh-cn/docs\\test\\katex-test#常用数学符号","lang":"zh-cn","tokens":["常用","用数","数学","学符","符号","常","用","数","学","符","号","希腊","腊字","字母","希","腊","字","母","关系","系符","关","系","集合","合符","集","合","箭头","箭","头"]},{"id":"docs-test-katex-test--极限压力测试-很重要","pageTitle":"","sectionTitle":"🚨 极限压力测试（很重要）","content":"如果这一段渲染正常，说明 KaTeX 基本完全 OK","url":"/zh-cn/docs\\test\\katex-test#极限压力测试-很重要","lang":"zh-cn","tokens":["极限","限压","压力","力测","测试","极","限","压","力","测","试","很重","重要","很","重","要","如果","果这","这一","一段","段渲","渲染","染正","正常","如","果","这","一","段","渲","染","正","常","说明","说","明","katex","基本","本完","完全","基","本","完","全","ok"]},{"id":"docs-test-katex-test--渲染检查清单","pageTitle":"","sectionTitle":"✅ 渲染检查清单","content":"行内公式正常 块级公式居中 矩阵对齐正确 mhchem 正常 physics 宏正常 对齐环境正常 移动端不溢出 暗色模式可见","url":"/zh-cn/docs\\test\\katex-test#渲染检查清单","lang":"zh-cn","tokens":["渲染","染检","检查","查清","清单","渲","染","检","查","清","单","行内","内公","公式","式正","正常","行","内","公","式","正","常","块级","级公","式居","居中","块","级","居","中","矩阵","阵对","对齐","齐正","正确","矩","阵","对","齐","确","mhchem","physics","宏正","宏","齐环","环境","境正","环","境","移动","动端","端不","不溢","溢出","移","动","端","不","溢","出","暗色","色模","模式","式可","可见","暗","色","模","可","见"]},{"id":"docs-test-katex-test--如果全部通过","pageTitle":"","sectionTitle":"🎉 如果全部通过","content":"👉 你的 KaTeX 配置已经是 完整版","url":"/zh-cn/docs\\test\\katex-test#如果全部通过","lang":"zh-cn","tokens":["如果","果全","全部","部通","通过","如","果","全","部","通","过","你的","你","的","katex","配置","置已","已经","经是","配","置","已","经","是","完整","整版","完","整","版"]},{"id":"docs-test-mdx-test--mdx-组件使用示例","pageTitle":"","sectionTitle":"MDX 组件使用示例","content":"本页面演示了如何在 Markdown 文档中使用自定义 React 组件。","url":"/zh-cn/docs\\test\\mdx-test#mdx-组件使用示例","lang":"zh-cn","tokens":["mdx","组件","件使","使用","用示","示例","组","件","使","用","示","例","本页","页面","面演","演示","示了","了如","如何","何在","本","页","面","演","了","如","何","在","markdown","文档","档中","中使","用自","自定","定义","文","档","中","自","定","义","react"]},{"id":"docs-test-mdx-test--使用内置组件","pageTitle":"","sectionTitle":"使用内置组件","content":"react-docs-ui 提供了一些内置的 MDX 组件，可以直接使用。 注意 ：组件名称支持 PascalCase（推荐）和小写两种写法。例如， <CodeBlock 和 <codeblock 都可以正常工作。","url":"/zh-cn/docs\\test\\mdx-test#使用内置组件","lang":"zh-cn","tokens":["使用","用内","内置","置组","组件","使","用","内","置","组","件","react","docs","ui","提供","供了","了一","一些","些内","置的","提","供","了","一","些","的","mdx","可以","以直","直接","接使","可","以","直","接","注意","注","意","件名","名称","称支","支持","名","称","支","持","pascalcase","推荐","推","荐","和小","小写","写两","两种","种写","写法","和","小","写","两","种","法","例如","例","如","codeblock","都可","以正","正常","常工","工作","都","正","常","工","作"]},{"id":"docs-test-mdx-test--使用自定义组件","pageTitle":"","sectionTitle":"使用自定义组件","content":"在 template 的 src/components 目录下创建的 React 组件会自动被扫描并注册，可以直接在 MDX 文档中使用：","url":"/zh-cn/docs\\test\\mdx-test#使用自定义组件","lang":"zh-cn","tokens":["使用","用自","自定","定义","义组","组件","使","用","自","定","义","组","件","在","template","的","src","components","目录","录下","下创","创建","建的","目","录","下","创","建","react","件会","会自","自动","动被","被扫","扫描","描并","并注","注册","会","动","被","扫","描","并","注","册","可以","以直","直接","接在","可","以","直","接","mdx","文档","档中","中使","文","档","中"]},{"id":"docs-test-mdx-test--alert-组件","pageTitle":"","sectionTitle":"Alert 组件","content":"Alert 组件支持多种类型：info、success、warning、error","url":"/zh-cn/docs\\test\\mdx-test#alert-组件","lang":"zh-cn","tokens":["alert","组件","组","件","件支","支持","持多","多种","种类","类型","支","持","多","种","类","型","info","success","warning","error"]},{"id":"docs-test-mdx-test--feature-组件","pageTitle":"","sectionTitle":"Feature 组件","content":"Feature 组件用于展示功能特性： <Feature icon=\"⚡\" title=\"快速启动\" description=\"只需几秒钟即可启动项目，无需复杂配置。\" <Feature icon=\"🎨\" title=\"主题定制\" description=\"支持亮色和暗色主题，完全可定制。\" <Feature icon=\"📱\" title=\"响应式设计\" description=\"完美适配各种设备，提供最佳用户体验。\"","url":"/zh-cn/docs\\test\\mdx-test#feature-组件","lang":"zh-cn","tokens":["feature","组件","组","件","件用","用于","于展","展示","示功","功能","能特","特性","用","于","展","示","功","能","特","性","icon","title","快速","速启","启动","快","速","启","动","description","只需","需几","几秒","秒钟","钟即","即可","可启","动项","项目","只","需","几","秒","钟","即","可","项","目","无需","需复","复杂","杂配","配置","无","复","杂","配","置","主题","题定","定制","主","题","定","制","支持","持亮","亮色","色和","和暗","暗色","色主","支","持","亮","色","和","暗","完全","全可","可定","完","全","响应","应式","式设","设计","响","应","式","设","计","完美","美适","适配","配各","各种","种设","设备","美","适","各","种","备","提供","供最","最佳","佳用","用户","户体","体验","提","供","最","佳","户","体","验"]},{"id":"docs-test-mdx-test--callout-组件","pageTitle":"","sectionTitle":"Callout 组件","content":"Callout 组件用于强调重要内容：","url":"/zh-cn/docs\\test\\mdx-test#callout-组件","lang":"zh-cn","tokens":["callout","组件","组","件","件用","用于","于强","强调","调重","重要","要内","内容","用","于","强","调","重","要","内","容"]},{"id":"docs-test-mdx-test--badgelist-组件","pageTitle":"","sectionTitle":"BadgeList 组件","content":"BadgeList 组件用于展示标签或状态：","url":"/zh-cn/docs\\test\\mdx-test#badgelist-组件","lang":"zh-cn","tokens":["badgelist","组件","组","件","件用","用于","于展","展示","示标","标签","签或","或状","状态","用","于","展","示","标","签","或","状","态"]},{"id":"docs-test-mdx-test--代码块示例","pageTitle":"","sectionTitle":"代码块示例","content":"你可以在 MDX 中使用标准的 Markdown 代码块语法：","url":"/zh-cn/docs\\test\\mdx-test#代码块示例","lang":"zh-cn","tokens":["代码","码块","块示","示例","代","码","块","示","例","你可","可以","以在","你","可","以","在","mdx","中使","使用","用标","标准","准的","中","使","用","标","准","的","markdown","块语","语法","语","法"]},{"id":"docs-test-test--文档渲染测试页","pageTitle":"","sectionTitle":"📄 文档渲染测试页","content":"用于测试文档网站是否正确渲染各种 Markdown / MDX 功能。","url":"/zh-cn/docs\\test\\test#文档渲染测试页","lang":"zh-cn","tokens":["文档","档渲","渲染","染测","测试","试页","文","档","渲","染","测","试","页","用于","于测","试文","档网","网站","站是","是否","否正","正确","确渲","染各","各种","用","于","网","站","是","否","正","确","各","种","markdown","mdx","功能","功","能"]},{"id":"docs-test-test--目录","pageTitle":"","sectionTitle":"🧭 目录","content":"标题测试 文本样式 列表 代码块 表格 引用块 提示块 图片 数学公式 MDX 组件（可选）","url":"/zh-cn/docs\\test\\test#目录","lang":"zh-cn","tokens":["目录","目","录","标题","题测","测试","标","题","测","试","文本","本样","样式","文","本","样","式","列表","列","表","代码","码块","代","码","块","表格","格","引用","用块","引","用","提示","示块","提","示","图片","图","片","数学","学公","公式","数","学","公","mdx","组件","组","件","可选","可","选"]},{"id":"docs-test-test--文本样式","pageTitle":"","sectionTitle":"文本样式","content":"粗体 斜体 删除线 行内代码 Ctrl + C","url":"/zh-cn/docs\\test\\test#文本样式","lang":"zh-cn","tokens":["文本","本样","样式","文","本","样","式","粗体","粗","体","斜体","斜","删除","除线","删","除","线","行内","内代","代码","行","内","代","码","ctrl","c"]},{"id":"docs-test-test--无序列表","pageTitle":"","sectionTitle":"无序列表","content":"Apple Banana 子项 1 子项 2 Orange","url":"/zh-cn/docs\\test\\test#无序列表","lang":"zh-cn","tokens":["无序","序列","列表","无","序","列","表","apple","banana","子项","子","项","1","2","orange"]},{"id":"docs-test-test--有序列表","pageTitle":"","sectionTitle":"有序列表","content":"第一步 第二步 第三步","url":"/zh-cn/docs\\test\\test#有序列表","lang":"zh-cn","tokens":["有序","序列","列表","有","序","列","表","第一","一步","第","一","步","第二","二步","二","第三","三步","三"]},{"id":"docs-test-test--任务列表","pageTitle":"","sectionTitle":"任务列表","content":"已完成 未完成","url":"/zh-cn/docs\\test\\test#任务列表","lang":"zh-cn","tokens":["任务","务列","列表","任","务","列","表","已完","完成","已","完","成","未完","未"]},{"id":"docs-test-test--表格","pageTitle":"","sectionTitle":"表格","content":"功能 是否支持 备注 标题 ✅ 正常 代码块 ✅ 高亮 数学公式 ⏳ 视主题而定","url":"/zh-cn/docs\\test\\test#表格","lang":"zh-cn","tokens":["表格","表","格","功能","功","能","是否","否支","支持","是","否","支","持","备注","备","注","标题","标","题","正常","正","常","代码","码块","代","码","块","高亮","高","亮","数学","学公","公式","数","学","公","式","视主","主题","题而","而定","视","主","而","定"]},{"id":"docs-test-test--引用块","pageTitle":"","sectionTitle":"引用块","content":"这是一个引用块 用于测试样式。","url":"/zh-cn/docs\\test\\test#引用块","lang":"zh-cn","tokens":["引用","用块","引","用","块","这是","是一","一个","个引","这","是","一","个","用于","于测","测试","试样","样式","于","测","试","样","式"]},{"id":"docs-test-test--提示块","pageTitle":"","sectionTitle":"提示块","content":"[!NOTE] 这是 NOTE 提示块（部分主题支持） [!TIP] 这是 TIP 提示块 [!WARNING] 这是 WARNING 提示块","url":"/zh-cn/docs\\test\\test#提示块","lang":"zh-cn","tokens":["提示","示块","提","示","块","note","这是","这","是","部分","分主","主题","题支","支持","部","分","主","题","支","持","tip","warning"]},{"id":"docs-test-test--图片","pageTitle":"","sectionTitle":"图片","content":"","url":"/zh-cn/docs\\test\\test#图片","lang":"zh-cn","tokens":["图片","图","片"]},{"id":"docs-test-test--数学公式","pageTitle":"","sectionTitle":"数学公式","content":"行内公式：  块级公式：","url":"/zh-cn/docs\\test\\test#数学公式","lang":"zh-cn","tokens":["数学","学公","公式","数","学","公","式","行内","内公","行","内","块级","级公","块","级"]},{"id":"docs-test-test--mdx-组件-可选","pageTitle":"","sectionTitle":"MDX 组件（可选）","content":"如果你的文档系统支持 MDX，可以测试：","url":"/zh-cn/docs\\test\\test#mdx-组件-可选","lang":"zh-cn","tokens":["mdx","组件","组","件","可选","可","选","如果","果你","你的","的文","文档","档系","系统","统支","支持","如","果","你","的","文","档","系","统","支","持","可以","以测","测试","以","测","试"]},{"id":"docs-test-test--折叠块-部分主题支持","pageTitle":"","sectionTitle":"🔥 折叠块（部分主题支持）","content":"这里是折叠内容。","url":"/zh-cn/docs\\test\\test#折叠块-部分主题支持","lang":"zh-cn","tokens":["折叠","叠块","折","叠","块","部分","分主","主题","题支","支持","部","分","主","题","支","持","这里","里是","是折","叠内","内容","这","里","是","内","容"]},{"id":"docs-test-test--长内容滚动测试","pageTitle":"","sectionTitle":"🧪 长内容滚动测试","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":"/zh-cn/docs\\test\\test#长内容滚动测试","lang":"zh-cn","tokens":["长内","内容","容滚","滚动","动测","测试","长","内","容","滚","动","测","试","lorem","ipsum","dolor","sit","amet","consectetur","adipiscing","elit","sed","do","eiusmod","tempor","incididunt","ut","labore","et","dolore","magna","aliqua","你可","可以","以复","复制","制多","多几","几段","段测","试滚","你","可","以","复","制","多","几","段"]},{"id":"docs-test-test--渲染检查清单","pageTitle":"","sectionTitle":"✅ 渲染检查清单","content":"代码高亮正常 表格样式正常 提示块有样式 数学公式正常 图片自适应 移动端响应式正常 测试完成 🎉 如果你愿意，我可以帮你再生成一个： 🔥 专门针对 Nextra 的测试版 🚀 专门针对 VitePress 的测试版 🎨 极限压力测试版（专测样式崩不崩） 你只要说一声 👍","url":"/zh-cn/docs\\test\\test#渲染检查清单","lang":"zh-cn","tokens":["渲染","染检","检查","查清","清单","渲","染","检","查","清","单","代码","码高","高亮","亮正","正常","代","码","高","亮","正","常","表格","格样","样式","式正","表","格","样","式","提示","示块","块有","有样","提","示","块","有","数学","学公","公式","数","学","公","图片","片自","自适","适应","图","片","自","适","应","移动","动端","端响","响应","应式","移","动","端","响","测试","试完","完成","测","试","完","成","如果","果你","你愿","愿意","如","果","你","愿","意","我可","可以","以帮","帮你","你再","再生","生成","成一","一个","我","可","以","帮","再","生","一","个","专门","门针","针对","专","门","针","对","nextra","的测","试版","的","版","vitepress","极限","限压","压力","力测","极","限","压","力","专测","测样","式崩","崩不","不崩","崩","不","你只","只要","要说","说一","一声","只","要","说","声"]},{"id":"docs-test--文档测试","pageTitle":"","sectionTitle":"文档测试","content":"这里汇集了各种文档功能的测试页面，用于验证 React Docs UI 的渲染能力。","url":"/zh-cn/docs\\test#文档测试","lang":"zh-cn","tokens":["文档","档测","测试","文","档","测","试","这里","里汇","汇集","集了","了各","各种","种文","档功","功能","能的","的测","试页","页面","这","里","汇","集","了","各","种","功","能","的","页","面","用于","于验","验证","用","于","验","证","react","docs","ui","的渲","渲染","染能","能力","渲","染","力"]},{"id":"docs-test--测试页面","pageTitle":"","sectionTitle":"测试页面","content":"MD 测试 - 测试各种 Markdown 语法和功能 KaTeX 测试 - 测试数学公式的完整功能 MDX 演示 - 查看 MDX 组件的使用示例","url":"/zh-cn/docs\\test#测试页面","lang":"zh-cn","tokens":["测试","试页","页面","测","试","页","面","md","试各","各种","各","种","markdown","语法","法和","和功","功能","语","法","和","功","能","katex","试数","数学","学公","公式","式的","的完","完整","整功","数","学","公","式","的","完","整","mdx","演示","演","示","查看","查","看","组件","件的","的使","使用","用示","示例","组","件","使","用","例"]},{"id":"docs--文档","pageTitle":"","sectionTitle":"文档","content":"欢迎使用 React Docs UI 文档系统。","url":"/zh-cn/docs#文档","lang":"zh-cn","tokens":["文档","文","档","欢迎","迎使","使用","欢","迎","使","用","react","docs","ui","档系","系统","系","统"]},{"id":"docs--快速开始","pageTitle":"","sectionTitle":"快速开始","content":"介绍 - 了解 React Docs UI 的核心理念 安装 - 学习如何安装和配置 快速上手 - 在 5 分钟内创建你的第一个文档网站 配置说明 - 深入了解配置选项 PDF Server 部署 - 部署 PDF 生成服务","url":"/zh-cn/docs#快速开始","lang":"zh-cn","tokens":["快速","速开","开始","快","速","开","始","介绍","介","绍","了解","了","解","react","docs","ui","的核","核心","心理","理念","的","核","心","理","念","安装","安","装","学习","习如","如何","何安","装和","和配","配置","学","习","如","何","和","配","置","速上","上手","上","手","在","5","分钟","钟内","内创","创建","建你","你的","的第","第一","一个","个文","文档","档网","网站","分","钟","内","创","建","你","第","一","个","文","档","网","站","置说","说明","说","明","深入","入了","解配","置选","选项","深","入","选","项","pdf","server","部署","部","署","生成","成服","服务","生","成","服","务"]},{"id":"docs--文档测试","pageTitle":"","sectionTitle":"文档测试","content":"MD 测试 - 测试 Markdown 渲染功能 KaTeX 测试 - 测试数学公式渲染 MDX 演示 - 查看 MDX 组件使用示例","url":"/zh-cn/docs#文档测试","lang":"zh-cn","tokens":["文档","档测","测试","文","档","测","试","md","markdown","渲染","染功","功能","渲","染","功","能","katex","试数","数学","学公","公式","式渲","数","学","公","式","mdx","演示","演","示","查看","查","看","组件","件使","使用","用示","示例","组","件","使","用","例"]},{"id":"index--react-docs-ui","pageTitle":"","sectionTitle":"React Docs UI","content":"一个基于 React 的、 配置驱动 的现代化文档网站构建工具。 React Docs UI 旨在让创建美观、功能强大的文档网站变得前所未有的简单。你只需专注于编写 Markdown 文档，其他的一切——从路由、导航到主题切换和命令菜单——都通过简单的 YAML 配置来驱动。","url":"/zh-cn/index#react-docs-ui","lang":"zh-cn","tokens":["react","docs","ui","一个","个基","基于","一","个","基","于","的","配置","置驱","驱动","配","置","驱","动","的现","现代","代化","化文","文档","档网","网站","站构","构建","建工","工具","现","代","化","文","档","网","站","构","建","工","具","旨在","在让","让创","创建","建美","美观","旨","在","让","创","美","观","功能","能强","强大","大的","的文","站变","变得","得前","前所","所未","未有","有的","的简","简单","功","能","强","大","变","得","前","所","未","有","简","单","你只","只需","需专","专注","注于","于编","编写","你","只","需","专","注","编","写","markdown","其他","他的","的一","一切","切—","——","—从","从路","路由","其","他","切","—","从","路","由","导航","航到","到主","主题","题切","切换","换和","和命","命令","令菜","菜单","单—","—都","都通","通过","过简","单的","导","航","到","主","题","换","和","命","令","菜","都","通","过","yaml","置来","来驱","来"]},{"id":"index--核心特性","pageTitle":"","sectionTitle":"核心特性","content":"配置驱动 : 无需编码，通过 site.yaml 定义你的整个网站。 开箱即用 : 极速启动项目，内置所有必需功能。 现代设计 : 优雅的响应式布局，支持明暗主题自动切换。 命令菜单 : 内置 Cmd+K 快捷菜单，快速访问页面。 Markdown 支持 : 全面支持 GFM 和 Frontmatter。 国际化 : 通过配置文件轻松实现多语言支持。","url":"/zh-cn/index#核心特性","lang":"zh-cn","tokens":["核心","心特","特性","核","心","特","性","配置","置驱","驱动","配","置","驱","动","无需","需编","编码","无","需","编","码","通过","通","过","site","yaml","定义","义你","你的","的整","整个","个网","网站","定","义","你","的","整","个","网","站","开箱","箱即","即用","开","箱","即","用","极速","速启","启动","动项","项目","极","速","启","项","目","内置","置所","所有","有必","必需","需功","功能","内","所","有","必","功","能","现代","代设","设计","现","代","设","计","优雅","雅的","的响","响应","应式","式布","布局","优","雅","响","应","式","布","局","支持","持明","明暗","暗主","主题","题自","自动","动切","切换","支","持","明","暗","主","题","自","切","换","命令","令菜","菜单","命","令","菜","单","cmd","k","快捷","捷菜","快","捷","快速","速访","访问","问页","页面","访","问","页","面","markdown","全面","面支","全","gfm","和","frontmatter","国际","际化","国","际","化","过配","置文","文件","件轻","轻松","松实","实现","现多","多语","语言","言支","文","件","轻","松","实","多","语","言"]},{"id":"index--快速开始","pageTitle":"","sectionTitle":"快速开始","content":"只需一个命令，即可拥有你的专属文档网站：","url":"/zh-cn/index#快速开始","lang":"zh-cn","tokens":["快速","速开","开始","快","速","开","始","只需","需一","一个","个命","命令","只","需","一","个","命","令","即可","可拥","拥有","有你","你的","的专","专属","属文","文档","档网","网站","即","可","拥","有","你","的","专","属","文","档","网","站"]},{"id":"index--链接","pageTitle":"","sectionTitle":"链接","content":"指南 : 开始了解 React Docs UI 的所有功能。 GitHub : 查看源码、提交问题或贡献代码。","url":"/zh-cn/index#链接","lang":"zh-cn","tokens":["链接","链","接","指南","指","南","开始","始了","了解","开","始","了","解","react","docs","ui","的所","所有","有功","功能","的","所","有","功","能","github","查看","看源","源码","查","看","源","码","提交","交问","问题","题或","或贡","贡献","献代","代码","提","交","问","题","或","贡","献","代"]}]}
+{"version":"2.0.0","generatedAt":1773315775206,"lang":"zh-cn","sections":[{"id":"docs-guide-configuration--配置文件-site-yaml-字段说明","pageTitle":"","sectionTitle":"配置文件（ `site.yaml` ）字段说明","content":"项目遵循“配置驱动”。绝大多数行为由 public/config/site.yaml 决定。下面用表格逐项说明所有字段。","url":"/zh-cn/docs\\guide\\configuration#配置文件-site-yaml-字段说明","lang":"zh-cn","tokens":["配置","置文","文件","配","置","文","件","site","yaml","字段","段说","说明","字","段","说","明","项目","目遵","遵循","循“","“配","置驱","驱动","动”","项","目","遵","循","“","驱","动","”","绝大","大多","多数","数行","行为","为由","绝","大","多","数","行","为","由","public","config","决定","决","定","下面","面用","用表","表格","格逐","逐项","项说","明所","所有","有字","下","面","用","表","格","逐","所","有"]},{"id":"docs-guide-configuration--顶级键","pageTitle":"","sectionTitle":"顶级键","content":"键 作用 site 全局元信息（标题、描述、Logo、作者） navbar 顶部导航（开关、导航项、操作按钮） sidebar 左侧导航树（集合/分组/子项） theme 主题配置（默认模式、是否允许切换） toc 文章右侧目录（开关、层级、标题） footer 页脚（链接、社交、仓库信息） contextMenu 右键菜单配置 mdx MDX 组件配置 pwa PWA 设置（预留/可选）","url":"/zh-cn/docs\\guide\\configuration#顶级键","lang":"zh-cn","tokens":["顶级","级键","顶","级","键","作用","作","用","site","全局","局元","元信","信息","全","局","元","信","息","标题","标","题","描述","描","述","logo","作者","者","navbar","顶部","部导","导航","部","导","航","开关","开","关","航项","项","操作","作按","按钮","操","按","钮","sidebar","左侧","侧导","航树","左","侧","树","集合","合/","/分","分组","组/","/子","子项","集","合","/","分","组","子","theme","主题","题配","配置","主","配","置","默认","认模","模式","默","认","模","式","是否","否允","允许","许切","切换","是","否","允","许","切","换","toc","文章","章右","右侧","侧目","目录","文","章","右","目","录","层级","层","footer","页脚","页","脚","链接","链","接","社交","社","交","仓库","库信","仓","库","contextmenu","右键","键菜","菜单","单配","菜","单","mdx","组件","件配","件","pwa","设置","设","预留","留/","/可","可选","预","留","可","选"]},{"id":"docs-guide-configuration--site","pageTitle":"","sectionTitle":"`site`","content":"字段 类型 说明 示例 title string 网站标题 \"React Docs UI 示例\" description string 简短网站描述（SEO） \"简单漂亮的文档站\" logo string 或 object 网站 Logo。字符串可为 emoji 或图片路径；对象可分别设置亮/暗图标 \"📚\" 、 \"/images/logo.png\" 、或 { light: \"/images/favicon.svg\", dark: \"/images/favicon-dark.svg\" } author string 作者或组织 \"React Docs UI Team\" Logo 支持： Emo...","url":"/zh-cn/docs\\guide\\configuration#site","lang":"zh-cn","tokens":["site","字段","字","段","类型","类","型","说明","说","明","示例","示","例","title","string","网站","站标","标题","网","站","标","题","react","docs","ui","description","简短","短网","站描","描述","简","短","描","述","seo","简单","单漂","漂亮","亮的","的文","文档","档站","单","漂","亮","的","文","档","logo","或","object","字符","符串","串可","可为","符","串","可","为","emoji","或图","图片","片路","路径","图","片","路","径","对象","象可","可分","分别","别设","设置","置亮","亮/","/暗","暗图","图标","对","象","分","别","设","置","/","暗","images","png","light","favicon","svg","dark","author","作者","者或","或组","组织","作","者","组","织","team","支持","支","持","公共","共路","径或","公","共","url","明/","暗主","主题","题对","主"]},{"id":"docs-guide-configuration--navbar","pageTitle":"","sectionTitle":"`navbar`","content":"字段 类型 说明 showLogo boolean 是否显示左上角 Logo showTitle boolean 是否显示站点标题 showLanguageSwitcher boolean 是否显示语言切换 items array 主导航链接 actions array 右侧操作按钮（如 GitHub） Item 字段 类型 说明 示例 title string 链接文字 \"指南\" link string 路径或 URL。内部路径以 / 开头 \"/guide\" external boolean(可选) 外部链接新开标签 visible boolean(可选) 条件展示 Action 字段 类型...","url":"/zh-cn/docs\\guide\\configuration#navbar","lang":"zh-cn","tokens":["navbar","字段","字","段","类型","类","型","说明","说","明","showlogo","boolean","是否","否显","显示","示左","左上","上角","是","否","显","示","左","上","角","logo","showtitle","示站","站点","点标","标题","站","点","标","题","showlanguageswitcher","示语","语言","言切","切换","语","言","切","换","items","array","主导","导航","航链","链接","主","导","航","链","接","actions","右侧","侧操","操作","作按","按钮","右","侧","操","作","按","钮","如","github","item","示例","例","title","string","接文","文字","文","指南","指","南","link","路径","径或","路","径","或","url","内部","部路","径以","内","部","以","开头","开","头","guide","external","bo","oo","ol","le","ea","an","n(","(可","可选","选)","b","o","l","e","a","n","(","可","选",")","外部","部链","接新","新开","开标","标签","外","新","签","visible","条件","件展","展示","条","件","展","action","type","custom","预设","设或","或自","自定","定义","义动","动作","预","设","自","定","义","动","st","tr","ri","in","ng","g(","s","t","r","i","g","钮文","文案","案","目标","标链","目","icon","作图","图标","标名","图","名","enabled","否启","启用","启","用"]},{"id":"docs-guide-configuration--sidebar","pageTitle":"","sectionTitle":"`sidebar`","content":"字段 类型 说明 enabled boolean(可选) 全局开启/关闭侧边栏 collections record<string, Collection 顶级集合映射（如 guide ） sections Section[] (兼容，可选) 旧版单树结构 Collection 字段 类型 说明 sections Section[] 一组可折叠分组 Section 字段 类型 说明 示例 title string 分组标题 \"快速开始\" path string 访问该前缀将自动展开/高亮 \"/guide\" children Child 该分组下的子链接 Child 字段 类型 说明 示例 ti...","url":"/zh-cn/docs\\guide\\configuration#sidebar","lang":"zh-cn","tokens":["sidebar","字段","字","段","类型","类","型","说明","说","明","enabled","bo","oo","ol","le","ea","an","n(","(可","可选","选)","b","o","l","e","a","n","(","可","选",")","全局","局开","开启","启/","/关","关闭","闭侧","侧边","边栏","全","局","开","启","/","关","闭","侧","边","栏","collections","record","string","collection","顶级","级集","集合","合映","映射","顶","级","集","合","映","射","如","guide","sections","section","(兼","兼容","兼","容","旧版","版单","单树","树结","结构","旧","版","单","树","结","构","一组","组可","可折","折叠","叠分","分组","一","组","折","叠","分","示例","示","例","title","组标","标题","标","题","快速","速开","开始","快","速","始","path","访问","问该","该前","前缀","缀将","将自","自动","动展","展开","开/","/高","高亮","访","问","该","前","缀","将","自","动","展","高","亮","children","child","该分","组下","下的","的子","子链","链接","下","的","子","链","接","接文","文字","文","介绍","介","绍","完整","整页","页面","面路","路径","完","整","页","面","路","径","introduction"]},{"id":"docs-guide-configuration--theme","pageTitle":"","sectionTitle":"`theme`","content":"字段 类型 说明 可选值 默认值 defaultMode string 默认主题模式 light / dark / auto auto allowToggle boolean 是否允许用户切换主题 true / false true","url":"/zh-cn/docs\\guide\\configuration#theme","lang":"zh-cn","tokens":["theme","字段","字","段","类型","类","型","说明","说","明","可选","选值","可","选","值","默认","认值","默","认","defaultmode","string","认主","主题","题模","模式","主","题","模","式","light","dark","auto","allowtoggle","boolean","是否","否允","允许","许用","用户","户切","切换","换主","是","否","允","许","用","户","切","换","true","false"]},{"id":"docs-guide-configuration--toc","pageTitle":"","sectionTitle":"`toc`","content":"字段 类型 说明 示例 enabled boolean 是否启用页面目录 true maxLevel number (1-6) 展示的最大标题层级 3 title string 目录标题 \"本页内容\" 说明：具体锚点与是否显示也可能受页面 Frontmatter 影响。","url":"/zh-cn/docs\\guide\\configuration#toc","lang":"zh-cn","tokens":["toc","字段","字","段","类型","类","型","说明","说","明","示例","示","例","enabled","boolean","是否","否启","启用","用页","页面","面目","目录","是","否","启","用","页","面","目","录","true","maxlevel","number","1","6","展示","示的","的最","最大","大标","标题","题层","层级","展","的","最","大","标","题","层","级","3","title","string","录标","本页","页内","内容","本","内","容","具体","体锚","锚点","点与","与是","否显","显示","示也","也可","可能","能受","受页","具","体","锚","点","与","显","也","可","能","受","frontmatter","影响","影","响"]},{"id":"docs-guide-configuration--footer","pageTitle":"","sectionTitle":"`footer`","content":"字段 类型 说明 enabled boolean 是否显示页脚 copyright string 版权文案 repository Repository(可选) 仓库信息（如“在 GitHub 上编辑此页”） lastUpdated string(可选) 站点/内容最近更新时间 links Link 页脚链接列 social Social 社交图标链接 Repository 字段 类型 说明 示例 url string 仓库地址 \"https://github.com/user/repo\" branch string 文档所在分支 \"main\" Link 字段 类型 说明 title strin...","url":"/zh-cn/docs\\guide\\configuration#footer","lang":"zh-cn","tokens":["footer","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","是否","否显","显示","示页","页脚","是","否","显","示","页","脚","copyright","string","版权","权文","文案","版","权","文","案","repository","Re","ep","po","os","si","it","to","or","ry","y(","(可","可选","选)","R","e","p","o","s","i","t","r","y","(","可","选",")","仓库","库信","信息","仓","库","信","息","如“","“在","如","“","在","github","上编","编辑","辑此","此页","页”","上","编","辑","此","”","lastupdated","st","tr","ri","in","ng","g(","n","g","站点","点/","/内","内容","容最","最近","近更","更新","新时","时间","站","点","/","内","容","最","近","更","新","时","间","links","link","脚链","链接","接列","链","接","列","social","社交","交图","图标","标链","社","交","图","标","示例","例","url","库地","地址","地","址","https","com","user","repo","branch","文档","档所","所在","在分","分支","档","所","分","支","main","title","接标","标题","题","路径","径或","路","径","或","external","bo","oo","ol","le","ea","an","n(","b","l","a","新开","开标","标签","开","签","name","平台","台名","名称","平","台","名","称","twitter","bilibili","个人","人页","页或","或链","个","人","icon","标名"]},{"id":"docs-guide-configuration--contextmenu","pageTitle":"","sectionTitle":"`contextMenu`","content":"字段 类型 说明 enabled boolean 全局开关，false 则完全禁用右键菜单 page object 页面组菜单项配置 site object 站点组菜单项配置 appearance object 外观组菜单项配置 Page 字段 类型 说明 默认值 copySelectedText boolean 复制选中的文字 true copyUrl boolean 复制当前链接 true copyTitle boolean 复制页面标题 false copyMarkdownLink boolean 复制 Markdown 链接 false openInNewTab boolean 在新标...","url":"/zh-cn/docs\\guide\\configuration#contextmenu","lang":"zh-cn","tokens":["contextmenu","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","全局","局开","开关","全","局","开","关","false","则完","完全","全禁","禁用","用右","右键","键菜","菜单","则","完","禁","用","右","键","菜","单","page","object","页面","面组","组菜","单项","项配","配置","页","面","组","项","配","置","site","站点","点组","站","点","appearance","外观","观组","外","观","默认","认值","默","认","值","copyselectedtext","复制","制选","选中","中的","的文","文字","复","制","选","中","的","文","true","copyurl","制当","当前","前链","链接","当","前","链","接","copytitle","制页","面标","标题","标","题","copymarkdownlink","markdown","openinnewtab","在新","新标","标签","签页","页打","打开","在","新","签","打","reload","刷新","刷","printpage","打印","印页","印","scrolltotop","回到","到顶","顶部","回","到","顶","部","scrolltobottom","滚动","动到","到底","底部","滚","动","底","gohome","返回","回首","首页","返","首","quicknav","快速","速跳","跳转","快","速","跳","转","language","语言","言切","切换","语","言","切","换","theme","主题","题切","主","resetthemepref","重置","置主","题偏","偏好","重","偏","好"]},{"id":"docs-guide-configuration--mdx","pageTitle":"","sectionTitle":"`mdx`","content":"字段 类型 说明 示例 componentsPath string 组件扫描路径 \"/src/components\" enabled boolean 启用 MDX 支持 true","url":"/zh-cn/docs\\guide\\configuration#mdx","lang":"zh-cn","tokens":["mdx","字段","字","段","类型","类","型","说明","说","明","示例","示","例","componentspath","string","组件","件扫","扫描","描路","路径","组","件","扫","描","路","径","src","components","enabled","boolean","启用","启","用","支持","支","持","true"]},{"id":"docs-guide-configuration--pwa-可选","pageTitle":"","sectionTitle":"`pwa` （可选）","content":"字段 类型 说明 enabled boolean 是否启用 PWA（预留） name string 应用名 shortName string 应用短名 description string 应用描述 themeColor string 主题色 backgroundColor string 背景色","url":"/zh-cn/docs\\guide\\configuration#pwa-可选","lang":"zh-cn","tokens":["pwa","可选","可","选","字段","字","段","类型","类","型","说明","说","明","enabled","boolean","是否","否启","启用","是","否","启","用","预留","预","留","name","string","应用","用名","应","名","shortname","用短","短名","短","description","用描","描述","描","述","themecolor","主题","题色","主","题","色","backgroundcolor","背景","景色","背","景"]},{"id":"docs-guide-installation--环境要求","pageTitle":"","sectionTitle":"环境要求","content":"在开始之前，请确保你的开发环境满足以下要求： Node.js : 版本 = 18.0.0 包管理器 : npm , yarn 或 pnpm","url":"/zh-cn/docs\\guide\\installation#环境要求","lang":"zh-cn","tokens":["环境","境要","要求","环","境","要","求","在开","开始","始之","之前","在","开","始","之","前","请确","确保","保你","你的","的开","开发","发环","境满","满足","足以","以下","下要","请","确","保","你","的","发","满","足","以","下","node","js","版本","版","本","18","0","包管","管理","理器","包","管","理","器","npm","yarn","或","pnpm"]},{"id":"docs-guide-installation--推荐方式-使用脚手架","pageTitle":"","sectionTitle":"推荐方式：使用脚手架","content":"我们强烈推荐使用官方的 create-react-docs-ui 脚手架来创建你的新文档项目。这是最快、最简单的方式，可以确保所有配置都已就绪。 运行创建命令 : 这会在当前目录下创建一个名为 my-docs 的新文件夹。 进入项目并安装依赖 : 启动开发服务器 : 现在，你的文档网站已经运行在 http://localhost:5173 (或另一个可用端口) 上了。","url":"/zh-cn/docs\\guide\\installation#推荐方式-使用脚手架","lang":"zh-cn","tokens":["推荐","荐方","方式","推","荐","方","式","使用","用脚","脚手","手架","使","用","脚","手","架","我们","们强","强烈","烈推","荐使","用官","官方","方的","我","们","强","烈","官","的","create","react","docs","ui","架来","来创","创建","建你","你的","的新","新文","文档","档项","项目","来","创","建","你","新","文","档","项","目","这是","是最","最快","这","是","最","快","最简","简单","单的","的方","简","单","可以","以确","确保","保所","所有","有配","配置","置都","都已","已就","就绪","可","以","确","保","所","有","配","置","都","已","就","绪","运行","行创","建命","命令","运","行","命","令","这会","会在","在当","当前","前目","目录","录下","下创","建一","一个","个名","名为","会","在","当","前","录","下","一","个","名","为","my","文件","件夹","件","夹","进入","入项","目并","并安","安装","装依","依赖","进","入","并","安","装","依","赖","启动","动开","开发","发服","服务","务器","启","动","开","发","服","务","器","现在","现","的文","档网","网站","站已","已经","经运","行在","网","站","经","http","localhost","5173","(或","或另","另一","个可","可用","用端","端口","口)","(","或","另","端","口",")","上了","上","了"]},{"id":"docs-guide-installation--手动安装-适用于现有项目","pageTitle":"","sectionTitle":"手动安装 (适用于现有项目)","content":"如果你想在已有的 Vite + React 项目中手动集成 react-docs-ui ，可以按照以下步骤操作： 安装核心库 : 创建配置文件 : 在你的 public 目录下创建一个 config 文件夹，并在其中新建一个 site.yaml 文件。你可以从 这里 复制一个基础模板。 创建文档目录 : 在 public 目录下创建一个 docs 文件夹，用于存放你的 Markdown 文件。例如: public/docs/zh-cn/index.md 。 修改应用入口文件 : 更新你的 src/main.tsx (或 main.jsx ) 文件，渲染 DocsApp 组件来初始化应用。 确保...","url":"/zh-cn/docs\\guide\\installation#手动安装-适用于现有项目","lang":"zh-cn","tokens":["手动","动安","安装","手","动","安","装","(适","适用","用于","于现","现有","有项","项目","目)","(","适","用","于","现","有","项","目",")","如果","果你","你想","想在","在已","已有","有的","如","果","你","想","在","已","的","vite","react","目中","中手","动集","集成","中","集","成","docs","ui","可以","以按","按照","照以","以下","下步","步骤","骤操","操作","可","以","按","照","下","步","骤","操","作","装核","核心","心库","核","心","库","创建","建配","配置","置文","文件","创","建","配","置","文","件","在你","你的","public","目录","录下","下创","建一","一个","录","一","个","config","件夹","夹","并在","在其","其中","中新","新建","并","其","新","site","yaml","你可","以从","从","这里","这","里","复制","制一","个基","基础","础模","模板","复","制","基","础","模","板","建文","文档","档目","档","于存","存放","放你","存","放","markdown","例如","如:","例",":","zh","cn","index","md","修改","改应","应用","用入","入口","口文","修","改","应","入","口","更新","新你","更","src","main","tsx","(或","或","jsx","渲染","渲","染","docsapp","组件","件来","来初","初始","始化","化应","组","来","初","始","化","确保","确","保","html","中有","div","id","root"]},{"id":"docs-guide-introduction--介绍","pageTitle":"","sectionTitle":"介绍","content":"React Docs UI 是一个专为构建现代化文档网站而设计的 React 组件库与工具集。它的核心哲学是 配置优于编码 ，让你能将精力完全集中在内容创作上。","url":"/zh-cn/docs\\guide\\introduction#介绍","lang":"zh-cn","tokens":["介绍","介","绍","react","docs","ui","是一","一个","个专","专为","为构","构建","建现","现代","代化","化文","文档","档网","网站","站而","而设","设计","计的","是","一","个","专","为","构","建","现","代","化","文","档","网","站","而","设","计","的","组件","件库","库与","与工","工具","具集","组","件","库","与","工","具","集","它的","的核","核心","心哲","哲学","学是","它","核","心","哲","学","配置","置优","优于","于编","编码","配","置","优","于","编","码","让你","你能","能将","将精","精力","力完","完全","全集","集中","中在","在内","内容","容创","创作","作上","让","你","能","将","精","力","完","全","中","在","内","容","创","作","上"]},{"id":"docs-guide-introduction--核心优势","pageTitle":"","sectionTitle":"核心优势","content":"配置驱动 : 这是 React Docs UI 最核心的特性。你不需要编写复杂的 React 组件或路由逻辑，只需维护一个清晰的 site.yaml 文件，就能定义网站的导航、侧边栏、主题、页脚等所有内容。 功能完备 : 开箱即用，提供了现代文档网站所需的一切： 响应式布局 明暗主题切换 基于 Markdown 的内容渲染 (支持 GFM 和 Frontmatter) 内置代码语法高亮 快捷命令菜单 (Cmd+K) 国际化支持 极简上手 : 通过官方的 create-react-docs-ui 脚手架，你可以在一分钟内启动一个功能齐全的文档网站，无需任何复杂的环境配置。 高度可定制 : 虽然开...","url":"/zh-cn/docs\\guide\\introduction#核心优势","lang":"zh-cn","tokens":["核心","心优","优势","核","心","优","势","配置","置驱","驱动","配","置","驱","动","这是","这","是","react","docs","ui","最核","心的","的特","特性","最","的","特","性","你不","不需","需要","要编","编写","写复","复杂","杂的","你","不","需","要","编","写","复","杂","组件","件或","或路","路由","由逻","逻辑","组","件","或","路","由","逻","辑","只需","需维","维护","护一","一个","个清","清晰","晰的","只","维","护","一","个","清","晰","site","yaml","文件","文","就能","能定","定义","义网","网站","站的","的导","导航","就","能","定","义","网","站","导","航","侧边","边栏","侧","边","栏","主题","主","题","页脚","脚等","等所","所有","有内","内容","页","脚","等","所","有","内","容","功能","能完","完备","功","完","备","开箱","箱即","即用","开","箱","即","用","提供","供了","了现","现代","代文","文档","档网","站所","所需","需的","的一","一切","提","供","了","现","代","档","切","响应","应式","式布","布局","响","应","式","布","局","明暗","暗主","题切","切换","明","暗","换","基于","基","于","markdown","的内","容渲","渲染","渲","染","(支","支持","(","支","持","gfm","和","frontmatter","内置","置代","代码","码语","语法","法高","高亮","码","语","法","高","亮","快捷","捷命","命令","令菜","菜单","快","捷","命","令","菜","单","cmd","k","国际","际化","化支","国","际","化","极简","简上","上手","极","简","上","手","通过","过官","官方","方的","通","过","官","方","create","脚手","手架","架","你可","可以","以在","在一","一分","分钟","钟内","内启","启动","动一","个功","能齐","齐全","全的","的文","可","以","在","分","钟","启","齐","全","无需","需任","任何","何复","的环","环境","境配","无","任","何","环","境","高度","度可","可定","定制","度","制","虽然","然开","虽","然","但每","每个","个部","部分","但","每","部","如","logo","配色","色","航链","链接","链","接","社交","交媒","媒体","体图","图标","标等","社","交","媒","体","图","标","都可","以通","过配","置文","件进","进行","行深","深度","度定","都","进","行","深"]},{"id":"docs-guide-introduction--适用场景","pageTitle":"","sectionTitle":"适用场景","content":"无论你是个人开发者还是团队，React Docs UI 都非常适合以下场景： 开源项目文档 : 为你的 React 项目提供一个专业、易于维护的文档网站。 产品手册 : 清晰地展示你的产品功能和使用指南。 团队知识库 : 在团队内部沉淀和分享基于 React 技术的知识。 个人博客或作品集 : 以优雅的方式组织和展示你的技术文章或项目。","url":"/zh-cn/docs\\guide\\introduction#适用场景","lang":"zh-cn","tokens":["适用","用场","场景","适","用","场","景","无论","论你","你是","是个","个人","人开","开发","发者","者还","还是","是团","团队","无","论","你","是","个","人","开","发","者","还","团","队","react","docs","ui","都非","非常","常适","适合","合以","以下","下场","都","非","常","合","以","下","开源","源项","项目","目文","文档","源","项","目","文","档","为你","你的","为","的","目提","提供","供一","一个","个专","专业","提","供","一","专","业","易于","于维","维护","护的","的文","档网","网站","易","于","维","护","网","站","产品","品手","手册","产","品","手","册","清晰","晰地","地展","展示","示你","的产","品功","功能","能和","和使","使用","用指","指南","清","晰","地","展","示","功","能","和","使","指","南","队知","知识","识库","知","识","库","在团","队内","内部","部沉","沉淀","淀和","和分","分享","享基","基于","在","内","部","沉","淀","分","享","基","技术","术的","的知","技","术","人博","博客","客或","或作","作品","品集","博","客","或","作","集","以优","优雅","雅的","的方","方式","式组","组织","织和","和展","的技","术文","文章","章或","或项","优","雅","方","式","组","织","章"]},{"id":"docs-guide-pdf-server--pdf-server-部署","pageTitle":"","sectionTitle":"PDF Server 部署","content":"React Docs UI 提供了 PDF 生成服务，可以独立部署为 Docker 容器。","url":"/zh-cn/docs\\guide\\pdf-server#pdf-server-部署","lang":"zh-cn","tokens":["pdf","server","部署","部","署","react","docs","ui","提供","供了","提","供","了","生成","成服","服务","生","成","服","务","可以","以独","独立","立部","署为","可","以","独","立","为","docker","容器","容","器"]},{"id":"docs-guide-pdf-server--使用-docker-compose","pageTitle":"","sectionTitle":"使用 Docker Compose","content":"创建 docker-compose.yml 文件： 启动服务：","url":"/zh-cn/docs\\guide\\pdf-server#使用-docker-compose","lang":"zh-cn","tokens":["使用","使","用","docker","compose","创建","创","建","yml","文件","文","件","启动","动服","服务","启","动","服","务"]},{"id":"docs-guide-pdf-server--api-接口","pageTitle":"","sectionTitle":"API 接口","content":"端点 方法 说明 /health GET 健康检查 /generate-pdf POST 生成 PDF（返回文件） /generate-pdf-sync POST 生成 PDF（返回 Base64）","url":"/zh-cn/docs\\guide\\pdf-server#api-接口","lang":"zh-cn","tokens":["api","接口","接","口","端点","端","点","方法","方","法","说明","说","明","health","get","健康","康检","检查","健","康","检","查","generate","pdf","post","生成","生","成","返回","回文","文件","返","回","文","件","sync","base64"]},{"id":"docs-guide-pdf-server--资源配置","pageTitle":"","sectionTitle":"资源配置","content":"PDF Server 基于 Puppeteer/Chromium 运行，建议配置： 场景 推荐内存 低并发（1-2 请求） 512MB 中等并发 1GB 高并发 2GB+","url":"/zh-cn/docs\\guide\\pdf-server#资源配置","lang":"zh-cn","tokens":["资源","源配","配置","资","源","配","置","pdf","server","基于","基","于","puppeteer","chromium","运行","运","行","建议","议配","建","议","场景","场","景","推荐","荐内","内存","推","荐","内","存","低并","并发","低","并","发","1","2","请求","请","求","512mb","中等","等并","中","等","1gb","高并","高","2gb"]},{"id":"docs-guide-pdf-server--环境变量","pageTitle":"","sectionTitle":"环境变量","content":"变量 默认值 说明 PDFSERVERPORT 3001 服务端口（Docker 镜像默认 6965）","url":"/zh-cn/docs\\guide\\pdf-server#环境变量","lang":"zh-cn","tokens":["环境","境变","变量","环","境","变","量","默认","认值","默","认","值","说明","说","明","pdfserverport","3001","服务","务端","端口","服","务","端","口","docker","镜像","像默","镜","像","6965"]},{"id":"docs-guide-quick-start--快速上手","pageTitle":"","sectionTitle":"快速上手","content":"本指南将引导你在 5 分钟内，从零开始创建、配置并运行一个属于你自己的 React 文档网站。","url":"/zh-cn/docs\\guide\\quick-start#快速上手","lang":"zh-cn","tokens":["快速","速上","上手","快","速","上","手","本指","指南","南将","将引","引导","导你","你在","本","指","南","将","引","导","你","在","5","分钟","钟内","分","钟","内","从零","零开","开始","始创","创建","从","零","开","始","创","建","配置","置并","并运","运行","行一","一个","个属","属于","于你","你自","自己","己的","配","置","并","运","行","一","个","属","于","自","己","的","react","文档","档网","网站","文","档","网","站"]},{"id":"docs-guide-quick-start--1-创建项目","pageTitle":"","sectionTitle":"1. 创建项目","content":"使用官方脚手架是最高效的方式。打开你的终端，运行以下命令： 然后，进入项目目录并安装依赖：","url":"/zh-cn/docs\\guide\\quick-start#1-创建项目","lang":"zh-cn","tokens":["1","创建","建项","项目","创","建","项","目","使用","用官","官方","方脚","脚手","手架","架是","是最","最高","高效","效的","的方","方式","使","用","官","方","脚","手","架","是","最","高","效","的","式","打开","开你","你的","的终","终端","打","开","你","终","端","运行","行以","以下","下命","命令","运","行","以","下","命","令","然后","然","后","进入","入项","目目","目录","录并","并安","安装","装依","依赖","进","入","录","并","安","装","依","赖"]},{"id":"docs-guide-quick-start--2-组织你的文档","pageTitle":"","sectionTitle":"2. 组织你的文档","content":"所有的文档内容都以 Markdown 文件的形式存放在 public/docs/ 目录下。 打开 public/docs/zh-cn/ 目录。 你可以修改现有的 index.md 和 guide 目录下的文件，或者创建新的 .md 文件。 例如，我们来创建一个新页面。在 public/docs/zh-cn/ 新建 about 目录以及 about.md 文件 , about.md 的内容如下","url":"/zh-cn/docs\\guide\\quick-start#2-组织你的文档","lang":"zh-cn","tokens":["2","组织","织你","你的","的文","文档","组","织","你","的","文","档","所有","有的","档内","内容","容都","都以","所","有","内","容","都","以","markdown","文件","件的","的形","形式","式存","存放","放在","件","形","式","存","放","在","public","docs","目录","录下","目","录","下","打开","打","开","zh","cn","你可","可以","以修","修改","改现","现有","可","修","改","现","index","md","和","guide","下的","或者","者创","创建","建新","新的","或","者","创","建","新","例如","例","如","我们","们来","来创","建一","一个","个新","新页","页面","我","们","来","一","个","页","面","新建","about","录以","以及","及","的内","容如","如下"]},{"id":"docs-guide-quick-start--3-配置网站","pageTitle":"","sectionTitle":"3. 配置网站","content":"现在，让我们通过修改配置文件来展示新创建的页面。 打开核心配置文件 public/config/site.yaml 。","url":"/zh-cn/docs\\guide\\quick-start#3-配置网站","lang":"zh-cn","tokens":["3","配置","置网","网站","配","置","网","站","现在","现","在","让我","我们","们通","通过","过修","修改","改配","置文","文件","件来","来展","展示","示新","新创","创建","建的","的页","页面","让","我","们","通","过","修","改","文","件","来","展","示","新","创","建","的","页","面","打开","开核","核心","心配","打","开","核","心","public","config","site","yaml"]},{"id":"docs-guide-quick-start--a-修改网站信息","pageTitle":"","sectionTitle":"a. 修改网站信息","content":"更新 site 部分，给你的网站一个新标题和 Logo。","url":"/zh-cn/docs\\guide\\quick-start#a-修改网站信息","lang":"zh-cn","tokens":["a","修改","改网","网站","站信","信息","修","改","网","站","信","息","更新","更","新","site","部分","部","分","给你","你的","的网","站一","一个","个新","新标","标题","题和","给","你","的","一","个","标","题","和","logo"]},{"id":"docs-guide-quick-start--b-添加到导航栏","pageTitle":"","sectionTitle":"b. 添加到导航栏","content":"在 navbar.items 数组中，为“关于”页面添加一个链接。","url":"/zh-cn/docs\\guide\\quick-start#b-添加到导航栏","lang":"zh-cn","tokens":["b","添加","加到","到导","导航","航栏","添","加","到","导","航","栏","在","navbar","items","数组","组中","数","组","中","为“","“关","关于","于”","”页","页面","面添","加一","一个","个链","链接","为","“","关","于","”","页","面","一","个","链","接"]},{"id":"docs-guide-quick-start--c-添加到侧边栏","pageTitle":"","sectionTitle":"c. 添加到侧边栏","content":"为了让“关于”页面在侧边栏也可见，我们在 新建一个 sidebar.collections.about.sections ，并且添加一个新条目。 这里侧边栏的about项还需要再创建一个文件 public/docs/zh-cn/about 下 创建about.md","url":"/zh-cn/docs\\guide\\quick-start#c-添加到侧边栏","lang":"zh-cn","tokens":["c","添加","加到","到侧","侧边","边栏","添","加","到","侧","边","栏","为了","了让","让“","“关","关于","于”","”页","页面","面在","在侧","栏也","也可","可见","为","了","让","“","关","于","”","页","面","在","也","可","见","我们","们在","我","们","新建","建一","一个","新","建","一","个","sidebar","collections","about","sections","并且","且添","加一","个新","新条","条目","并","且","条","目","这里","里侧","栏的","的a","ab","bo","ou","ut","t项","项还","还需","需要","要再","再创","创建","个文","文件","这","里","的","a","b","o","u","t","项","还","需","要","再","创","文","件","public","docs","zh","cn","下","建a","t.",".m","md",".","m","d"]},{"id":"docs-guide-quick-start--4-启动网站","pageTitle":"","sectionTitle":"4. 启动网站","content":"保存你的所有修改，然后在终端运行： 你的网站现在应该运行在 http://localhost:5173 上了。访问它，你会看到更新后的标题、Logo，以及导航栏和侧边栏中新增的“关于”链接。恭喜你，你已经成功掌握了 React Docs UI 的基本工作流程！","url":"/zh-cn/docs\\guide\\quick-start#4-启动网站","lang":"zh-cn","tokens":["4","启动","动网","网站","启","动","网","站","保存","存你","你的","的所","所有","有修","修改","保","存","你","的","所","有","修","改","然后","后在","在终","终端","端运","运行","然","后","在","终","端","运","行","的网","站现","现在","在应","应该","该运","行在","现","应","该","http","localhost","5173","上了","上","了","访问","问它","访","问","它","你会","会看","看到","到更","更新","新后","后的","的标","标题","会","看","到","更","新","标","题","logo","以及","及导","导航","航栏","栏和","和侧","侧边","边栏","栏中","中新","新增","增的","的“","“关","关于","于”","”链","链接","以","及","导","航","栏","和","侧","边","中","增","“","关","于","”","链","接","恭喜","喜你","恭","喜","你已","已经","经成","成功","功掌","掌握","握了","已","经","成","功","掌","握","react","docs","ui","的基","基本","本工","工作","作流","流程","基","本","工","作","流","程"]},{"id":"docs-guide--指南","pageTitle":"","sectionTitle":"指南","content":"本指南将帮助你全面了解并掌握 React Docs UI 的各项功能。无论你是初学者还是希望进行深度定制，都能在这里找到所需的信息。","url":"/zh-cn/docs\\guide#指南","lang":"zh-cn","tokens":["指南","指","南","本指","南将","将帮","帮助","助你","你全","全面","面了","了解","解并","并掌","掌握","本","将","帮","助","你","全","面","了","解","并","掌","握","react","docs","ui","的各","各项","项功","功能","的","各","项","功","能","无论","论你","你是","是初","初学","学者","者还","还是","是希","希望","望进","进行","行深","深度","度定","定制","无","论","是","初","学","者","还","希","望","进","行","深","度","定","制","都能","能在","在这","这里","里找","找到","到所","所需","需的","的信","信息","都","在","这","里","找","到","所","需","信","息"]},{"id":"docs-guide--目录","pageTitle":"","sectionTitle":"目录","content":"介绍 : 了解 React Docs UI 的核心理念和主要优势。 安装 : 学习如何通过脚手架或手动方式安装。 快速上手 : 在 5 分钟内创建并运行你的第一个文档网站。 配置说明 ( site.yaml ) : 深入了解每个配置项，完全掌控你的网站。","url":"/zh-cn/docs\\guide#目录","lang":"zh-cn","tokens":["目录","目","录","介绍","介","绍","了解","了","解","react","docs","ui","的核","核心","心理","理念","念和","和主","主要","要优","优势","的","核","心","理","念","和","主","要","优","势","安装","安","装","学习","习如","如何","何通","通过","过脚","脚手","手架","架或","或手","手动","动方","方式","式安","学","习","如","何","通","过","脚","手","架","或","动","方","式","快速","速上","上手","快","速","上","在","5","分钟","钟内","内创","创建","建并","并运","运行","行你","你的","的第","第一","一个","个文","文档","档网","网站","分","钟","内","创","建","并","运","行","你","第","一","个","文","档","网","站","配置","置说","说明","配","置","说","明","site","yaml","深入","入了","解每","每个","个配","置项","深","入","每","项","完全","全掌","掌控","控你","的网","完","全","掌","控"]},{"id":"docs-test-frontmatter-test--frontmatter-功能测试","pageTitle":"Frontmatter 测试页面","sectionTitle":"Frontmatter 功能测试","content":"这个页面用于测试 Frontmatter 字段的展示功能。","url":"/zh-cn/docs\\test\\frontmatter-test#frontmatter-功能测试","lang":"zh-cn","tokens":["frontmatter","功能","能测","测试","功","能","测","试","这个","个页","页面","面用","用于","于测","这","个","页","面","用","于","字段","段的","的展","展示","示功","字","段","的","展","示"]},{"id":"docs-test-frontmatter-test--测试说明","pageTitle":"Frontmatter 测试页面","sectionTitle":"测试说明","content":"如果你能看到页面上方的标题、描述、作者和日期信息，说明 Frontmatter 展示功能正常工作。","url":"/zh-cn/docs\\test\\frontmatter-test#测试说明","lang":"zh-cn","tokens":["测试","试说","说明","测","试","说","明","如果","果你","你能","能看","看到","到页","页面","面上","上方","方的","的标","标题","如","果","你","能","看","到","页","面","上","方","的","标","题","描述","描","述","作者","者和","和日","日期","期信","信息","作","者","和","日","期","信","息","frontmatter","展示","示功","功能","能正","正常","常工","工作","展","示","功","正","常","工"]},{"id":"docs-test-frontmatter-test--支持的字段","pageTitle":"Frontmatter 测试页面","sectionTitle":"支持的字段","content":"字段 说明 title 页面标题，会显示在内容区顶部，并设置为浏览器标签页标题 description 页面描述，显示在标题下方 author 作者信息，显示在描述下方 date 发布日期，显示在作者旁边","url":"/zh-cn/docs\\test\\frontmatter-test#支持的字段","lang":"zh-cn","tokens":["支持","持的","的字","字段","支","持","的","字","段","说明","说","明","title","页面","面标","标题","页","面","标","题","会显","显示","示在","在内","内容","容区","区顶","顶部","会","显","示","在","内","容","区","顶","部","并设","设置","置为","为浏","浏览","览器","器标","标签","签页","页标","并","设","置","为","浏","览","器","签","description","面描","描述","描","述","在标","题下","下方","下","方","author","作者","者信","信息","作","者","信","息","在描","述下","date","发布","布日","日期","发","布","日","期","在作","者旁","旁边","旁","边"]},{"id":"docs-test-frontmatter-test--普通内容","pageTitle":"Frontmatter 测试页面","sectionTitle":"普通内容","content":"这里是普通的 Markdown 内容，会正常渲染。 列表项 1 列表项 2 列表项 3 代码块测试： 测试完成 ✅","url":"/zh-cn/docs\\test\\frontmatter-test#普通内容","lang":"zh-cn","tokens":["普通","通内","内容","普","通","内","容","这里","里是","是普","通的","这","里","是","的","markdown","会正","正常","常渲","渲染","会","正","常","渲","染","列表","表项","列","表","项","1","2","3","代码","码块","块测","测试","代","码","块","测","试","试完","完成","完","成"]},{"id":"docs-test-katex-test--katex-全功能测试","pageTitle":"","sectionTitle":"🧪 KaTeX 全功能测试","content":"用于验证 KaTeX 是否正确加载所有扩展（mhchem / physics / mathtools 等）","url":"/zh-cn/docs\\test\\katex-test#katex-全功能测试","lang":"zh-cn","tokens":["katex","全功","功能","能测","测试","全","功","能","测","试","用于","于验","验证","用","于","验","证","是否","否正","正确","确加","加载","载所","所有","有扩","扩展","是","否","正","确","加","载","所","有","扩","展","mhchem","physics","mathtools","等"]},{"id":"docs-test-katex-test--行内公式","pageTitle":"","sectionTitle":"✅ 行内公式","content":"爱因斯坦质能方程：  欧拉公式：  分数测试：  根号测试：","url":"/zh-cn/docs\\test\\katex-test#行内公式","lang":"zh-cn","tokens":["行内","内公","公式","行","内","公","式","爱因","因斯","斯坦","坦质","质能","能方","方程","爱","因","斯","坦","质","能","方","程","欧拉","拉公","欧","拉","分数","数测","测试","分","数","测","试","根号","号测","根","号"]},{"id":"docs-test-katex-test--块级公式","pageTitle":"","sectionTitle":"✅ 块级公式","content":"","url":"/zh-cn/docs\\test\\katex-test#块级公式","lang":"zh-cn","tokens":["块级","级公","公式","块","级","公","式"]},{"id":"docs-test-katex-test--基础矩阵","pageTitle":"","sectionTitle":"基础矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#基础矩阵","lang":"zh-cn","tokens":["基础","础矩","矩阵","基","础","矩","阵"]},{"id":"docs-test-katex-test--括号矩阵","pageTitle":"","sectionTitle":"括号矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#括号矩阵","lang":"zh-cn","tokens":["括号","号矩","矩阵","括","号","矩","阵"]},{"id":"docs-test-katex-test--方括号矩阵","pageTitle":"","sectionTitle":"方括号矩阵","content":"","url":"/zh-cn/docs\\test\\katex-test#方括号矩阵","lang":"zh-cn","tokens":["方括","括号","号矩","矩阵","方","括","号","矩","阵"]},{"id":"docs-test-katex-test--行列式","pageTitle":"","sectionTitle":"行列式","content":"","url":"/zh-cn/docs\\test\\katex-test#行列式","lang":"zh-cn","tokens":["行列","列式","行","列","式"]},{"id":"docs-test-katex-test--对齐环境-ams","pageTitle":"","sectionTitle":"✅ 对齐环境（ams）","content":"","url":"/zh-cn/docs\\test\\katex-test#对齐环境-ams","lang":"zh-cn","tokens":["对齐","齐环","环境","对","齐","环","境","ams"]},{"id":"docs-test-katex-test--分段函数","pageTitle":"","sectionTitle":"✅ 分段函数","content":"","url":"/zh-cn/docs\\test\\katex-test#分段函数","lang":"zh-cn","tokens":["分段","段函","函数","分","段","函","数"]},{"id":"docs-test-katex-test--化学公式-mhchem","pageTitle":"","sectionTitle":"✅ 化学公式（mhchem）","content":"水：  燃烧反应：  可逆反应：  离子：","url":"/zh-cn/docs\\test\\katex-test#化学公式-mhchem","lang":"zh-cn","tokens":["化学","学公","公式","化","学","公","式","mhchem","水","燃烧","烧反","反应","燃","烧","反","应","可逆","逆反","可","逆","离子","离","子"]},{"id":"docs-test-katex-test--physics-宏测试","pageTitle":"","sectionTitle":"✅ physics 宏测试","content":"导数：  偏导：  二阶导：  绝对值：  范数：  期望值：  括号自动伸缩：","url":"/zh-cn/docs\\test\\katex-test#physics-宏测试","lang":"zh-cn","tokens":["physics","宏测","测试","宏","测","试","导数","导","数","偏导","偏","二阶","阶导","二","阶","绝对","对值","绝","对","值","范数","范","期望","望值","期","望","括号","号自","自动","动伸","伸缩","括","号","自","动","伸","缩"]},{"id":"docs-test-katex-test--mathtools-扩展","pageTitle":"","sectionTitle":"✅ mathtools 扩展","content":"多行对齐：  带标签：","url":"/zh-cn/docs\\test\\katex-test#mathtools-扩展","lang":"zh-cn","tokens":["mathtools","扩展","扩","展","多行","行对","对齐","多","行","对","齐","带标","标签","带","标","签"]},{"id":"docs-test-katex-test--常用数学符号","pageTitle":"","sectionTitle":"✅ 常用数学符号","content":"希腊字母：  关系符号：  集合符号：  箭头：","url":"/zh-cn/docs\\test\\katex-test#常用数学符号","lang":"zh-cn","tokens":["常用","用数","数学","学符","符号","常","用","数","学","符","号","希腊","腊字","字母","希","腊","字","母","关系","系符","关","系","集合","合符","集","合","箭头","箭","头"]},{"id":"docs-test-katex-test--极限压力测试-很重要","pageTitle":"","sectionTitle":"🚨 极限压力测试（很重要）","content":"如果这一段渲染正常，说明 KaTeX 基本完全 OK","url":"/zh-cn/docs\\test\\katex-test#极限压力测试-很重要","lang":"zh-cn","tokens":["极限","限压","压力","力测","测试","极","限","压","力","测","试","很重","重要","很","重","要","如果","果这","这一","一段","段渲","渲染","染正","正常","如","果","这","一","段","渲","染","正","常","说明","说","明","katex","基本","本完","完全","基","本","完","全","ok"]},{"id":"docs-test-katex-test--渲染检查清单","pageTitle":"","sectionTitle":"✅ 渲染检查清单","content":"行内公式正常 块级公式居中 矩阵对齐正确 mhchem 正常 physics 宏正常 对齐环境正常 移动端不溢出 暗色模式可见","url":"/zh-cn/docs\\test\\katex-test#渲染检查清单","lang":"zh-cn","tokens":["渲染","染检","检查","查清","清单","渲","染","检","查","清","单","行内","内公","公式","式正","正常","行","内","公","式","正","常","块级","级公","式居","居中","块","级","居","中","矩阵","阵对","对齐","齐正","正确","矩","阵","对","齐","确","mhchem","physics","宏正","宏","齐环","环境","境正","环","境","移动","动端","端不","不溢","溢出","移","动","端","不","溢","出","暗色","色模","模式","式可","可见","暗","色","模","可","见"]},{"id":"docs-test-katex-test--如果全部通过","pageTitle":"","sectionTitle":"🎉 如果全部通过","content":"👉 你的 KaTeX 配置已经是 完整版","url":"/zh-cn/docs\\test\\katex-test#如果全部通过","lang":"zh-cn","tokens":["如果","果全","全部","部通","通过","如","果","全","部","通","过","你的","你","的","katex","配置","置已","已经","经是","配","置","已","经","是","完整","整版","完","整","版"]},{"id":"docs-test-mdx-test--mdx-组件使用示例","pageTitle":"","sectionTitle":"MDX 组件使用示例","content":"本页面演示了如何在 Markdown 文档中使用自定义 React 组件。","url":"/zh-cn/docs\\test\\mdx-test#mdx-组件使用示例","lang":"zh-cn","tokens":["mdx","组件","件使","使用","用示","示例","组","件","使","用","示","例","本页","页面","面演","演示","示了","了如","如何","何在","本","页","面","演","了","如","何","在","markdown","文档","档中","中使","用自","自定","定义","文","档","中","自","定","义","react"]},{"id":"docs-test-mdx-test--使用内置组件","pageTitle":"","sectionTitle":"使用内置组件","content":"react-docs-ui 提供了一些内置的 MDX 组件，可以直接使用。 注意 ：组件名称支持 PascalCase（推荐）和小写两种写法。例如， <CodeBlock 和 <codeblock 都可以正常工作。","url":"/zh-cn/docs\\test\\mdx-test#使用内置组件","lang":"zh-cn","tokens":["使用","用内","内置","置组","组件","使","用","内","置","组","件","react","docs","ui","提供","供了","了一","一些","些内","置的","提","供","了","一","些","的","mdx","可以","以直","直接","接使","可","以","直","接","注意","注","意","件名","名称","称支","支持","名","称","支","持","pascalcase","推荐","推","荐","和小","小写","写两","两种","种写","写法","和","小","写","两","种","法","例如","例","如","codeblock","都可","以正","正常","常工","工作","都","正","常","工","作"]},{"id":"docs-test-mdx-test--使用自定义组件","pageTitle":"","sectionTitle":"使用自定义组件","content":"在 template 的 src/components 目录下创建的 React 组件会自动被扫描并注册，可以直接在 MDX 文档中使用：","url":"/zh-cn/docs\\test\\mdx-test#使用自定义组件","lang":"zh-cn","tokens":["使用","用自","自定","定义","义组","组件","使","用","自","定","义","组","件","在","template","的","src","components","目录","录下","下创","创建","建的","目","录","下","创","建","react","件会","会自","自动","动被","被扫","扫描","描并","并注","注册","会","动","被","扫","描","并","注","册","可以","以直","直接","接在","可","以","直","接","mdx","文档","档中","中使","文","档","中"]},{"id":"docs-test-mdx-test--alert-组件","pageTitle":"","sectionTitle":"Alert 组件","content":"Alert 组件支持多种类型：info、success、warning、error","url":"/zh-cn/docs\\test\\mdx-test#alert-组件","lang":"zh-cn","tokens":["alert","组件","组","件","件支","支持","持多","多种","种类","类型","支","持","多","种","类","型","info","success","warning","error"]},{"id":"docs-test-mdx-test--feature-组件","pageTitle":"","sectionTitle":"Feature 组件","content":"Feature 组件用于展示功能特性： <Feature icon=\"⚡\" title=\"快速启动\" description=\"只需几秒钟即可启动项目，无需复杂配置。\" <Feature icon=\"🎨\" title=\"主题定制\" description=\"支持亮色和暗色主题，完全可定制。\" <Feature icon=\"📱\" title=\"响应式设计\" description=\"完美适配各种设备，提供最佳用户体验。\"","url":"/zh-cn/docs\\test\\mdx-test#feature-组件","lang":"zh-cn","tokens":["feature","组件","组","件","件用","用于","于展","展示","示功","功能","能特","特性","用","于","展","示","功","能","特","性","icon","title","快速","速启","启动","快","速","启","动","description","只需","需几","几秒","秒钟","钟即","即可","可启","动项","项目","只","需","几","秒","钟","即","可","项","目","无需","需复","复杂","杂配","配置","无","复","杂","配","置","主题","题定","定制","主","题","定","制","支持","持亮","亮色","色和","和暗","暗色","色主","支","持","亮","色","和","暗","完全","全可","可定","完","全","响应","应式","式设","设计","响","应","式","设","计","完美","美适","适配","配各","各种","种设","设备","美","适","各","种","备","提供","供最","最佳","佳用","用户","户体","体验","提","供","最","佳","户","体","验"]},{"id":"docs-test-mdx-test--callout-组件","pageTitle":"","sectionTitle":"Callout 组件","content":"Callout 组件用于强调重要内容：","url":"/zh-cn/docs\\test\\mdx-test#callout-组件","lang":"zh-cn","tokens":["callout","组件","组","件","件用","用于","于强","强调","调重","重要","要内","内容","用","于","强","调","重","要","内","容"]},{"id":"docs-test-mdx-test--badgelist-组件","pageTitle":"","sectionTitle":"BadgeList 组件","content":"BadgeList 组件用于展示标签或状态：","url":"/zh-cn/docs\\test\\mdx-test#badgelist-组件","lang":"zh-cn","tokens":["badgelist","组件","组","件","件用","用于","于展","展示","示标","标签","签或","或状","状态","用","于","展","示","标","签","或","状","态"]},{"id":"docs-test-mdx-test--代码块示例","pageTitle":"","sectionTitle":"代码块示例","content":"你可以在 MDX 中使用标准的 Markdown 代码块语法：","url":"/zh-cn/docs\\test\\mdx-test#代码块示例","lang":"zh-cn","tokens":["代码","码块","块示","示例","代","码","块","示","例","你可","可以","以在","你","可","以","在","mdx","中使","使用","用标","标准","准的","中","使","用","标","准","的","markdown","块语","语法","语","法"]},{"id":"docs-test-test--文档渲染测试页","pageTitle":"","sectionTitle":"📄 文档渲染测试页","content":"用于测试文档网站是否正确渲染各种 Markdown / MDX 功能。","url":"/zh-cn/docs\\test\\test#文档渲染测试页","lang":"zh-cn","tokens":["文档","档渲","渲染","染测","测试","试页","文","档","渲","染","测","试","页","用于","于测","试文","档网","网站","站是","是否","否正","正确","确渲","染各","各种","用","于","网","站","是","否","正","确","各","种","markdown","mdx","功能","功","能"]},{"id":"docs-test-test--目录","pageTitle":"","sectionTitle":"🧭 目录","content":"标题测试 文本样式 列表 代码块 表格 引用块 提示块 图片 数学公式 MDX 组件（可选）","url":"/zh-cn/docs\\test\\test#目录","lang":"zh-cn","tokens":["目录","目","录","标题","题测","测试","标","题","测","试","文本","本样","样式","文","本","样","式","列表","列","表","代码","码块","代","码","块","表格","格","引用","用块","引","用","提示","示块","提","示","图片","图","片","数学","学公","公式","数","学","公","mdx","组件","组","件","可选","可","选"]},{"id":"docs-test-test--文本样式","pageTitle":"","sectionTitle":"文本样式","content":"粗体 斜体 删除线 行内代码 Ctrl + C","url":"/zh-cn/docs\\test\\test#文本样式","lang":"zh-cn","tokens":["文本","本样","样式","文","本","样","式","粗体","粗","体","斜体","斜","删除","除线","删","除","线","行内","内代","代码","行","内","代","码","ctrl","c"]},{"id":"docs-test-test--无序列表","pageTitle":"","sectionTitle":"无序列表","content":"Apple Banana 子项 1 子项 2 Orange","url":"/zh-cn/docs\\test\\test#无序列表","lang":"zh-cn","tokens":["无序","序列","列表","无","序","列","表","apple","banana","子项","子","项","1","2","orange"]},{"id":"docs-test-test--有序列表","pageTitle":"","sectionTitle":"有序列表","content":"第一步 第二步 第三步","url":"/zh-cn/docs\\test\\test#有序列表","lang":"zh-cn","tokens":["有序","序列","列表","有","序","列","表","第一","一步","第","一","步","第二","二步","二","第三","三步","三"]},{"id":"docs-test-test--任务列表","pageTitle":"","sectionTitle":"任务列表","content":"已完成 未完成","url":"/zh-cn/docs\\test\\test#任务列表","lang":"zh-cn","tokens":["任务","务列","列表","任","务","列","表","已完","完成","已","完","成","未完","未"]},{"id":"docs-test-test--表格","pageTitle":"","sectionTitle":"表格","content":"功能 是否支持 备注 标题 ✅ 正常 代码块 ✅ 高亮 数学公式 ⏳ 视主题而定","url":"/zh-cn/docs\\test\\test#表格","lang":"zh-cn","tokens":["表格","表","格","功能","功","能","是否","否支","支持","是","否","支","持","备注","备","注","标题","标","题","正常","正","常","代码","码块","代","码","块","高亮","高","亮","数学","学公","公式","数","学","公","式","视主","主题","题而","而定","视","主","而","定"]},{"id":"docs-test-test--引用块","pageTitle":"","sectionTitle":"引用块","content":"这是一个引用块 用于测试样式。","url":"/zh-cn/docs\\test\\test#引用块","lang":"zh-cn","tokens":["引用","用块","引","用","块","这是","是一","一个","个引","这","是","一","个","用于","于测","测试","试样","样式","于","测","试","样","式"]},{"id":"docs-test-test--提示块","pageTitle":"","sectionTitle":"提示块","content":"[!NOTE] 这是 NOTE 提示块（部分主题支持） [!TIP] 这是 TIP 提示块 [!WARNING] 这是 WARNING 提示块","url":"/zh-cn/docs\\test\\test#提示块","lang":"zh-cn","tokens":["提示","示块","提","示","块","note","这是","这","是","部分","分主","主题","题支","支持","部","分","主","题","支","持","tip","warning"]},{"id":"docs-test-test--图片","pageTitle":"","sectionTitle":"图片","content":"","url":"/zh-cn/docs\\test\\test#图片","lang":"zh-cn","tokens":["图片","图","片"]},{"id":"docs-test-test--数学公式","pageTitle":"","sectionTitle":"数学公式","content":"行内公式：  块级公式：","url":"/zh-cn/docs\\test\\test#数学公式","lang":"zh-cn","tokens":["数学","学公","公式","数","学","公","式","行内","内公","行","内","块级","级公","块","级"]},{"id":"docs-test-test--mdx-组件-可选","pageTitle":"","sectionTitle":"MDX 组件（可选）","content":"如果你的文档系统支持 MDX，可以测试：","url":"/zh-cn/docs\\test\\test#mdx-组件-可选","lang":"zh-cn","tokens":["mdx","组件","组","件","可选","可","选","如果","果你","你的","的文","文档","档系","系统","统支","支持","如","果","你","的","文","档","系","统","支","持","可以","以测","测试","以","测","试"]},{"id":"docs-test-test--折叠块-部分主题支持","pageTitle":"","sectionTitle":"🔥 折叠块（部分主题支持）","content":"这里是折叠内容。","url":"/zh-cn/docs\\test\\test#折叠块-部分主题支持","lang":"zh-cn","tokens":["折叠","叠块","折","叠","块","部分","分主","主题","题支","支持","部","分","主","题","支","持","这里","里是","是折","叠内","内容","这","里","是","内","容"]},{"id":"docs-test-test--长内容滚动测试","pageTitle":"","sectionTitle":"🧪 长内容滚动测试","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":"/zh-cn/docs\\test\\test#长内容滚动测试","lang":"zh-cn","tokens":["长内","内容","容滚","滚动","动测","测试","长","内","容","滚","动","测","试","lorem","ipsum","dolor","sit","amet","consectetur","adipiscing","elit","sed","do","eiusmod","tempor","incididunt","ut","labore","et","dolore","magna","aliqua","你可","可以","以复","复制","制多","多几","几段","段测","试滚","你","可","以","复","制","多","几","段"]},{"id":"docs-test-test--渲染检查清单","pageTitle":"","sectionTitle":"✅ 渲染检查清单","content":"代码高亮正常 表格样式正常 提示块有样式 数学公式正常 图片自适应 移动端响应式正常 测试完成 🎉 如果你愿意，我可以帮你再生成一个： 🔥 专门针对 Nextra 的测试版 🚀 专门针对 VitePress 的测试版 🎨 极限压力测试版（专测样式崩不崩） 你只要说一声 👍","url":"/zh-cn/docs\\test\\test#渲染检查清单","lang":"zh-cn","tokens":["渲染","染检","检查","查清","清单","渲","染","检","查","清","单","代码","码高","高亮","亮正","正常","代","码","高","亮","正","常","表格","格样","样式","式正","表","格","样","式","提示","示块","块有","有样","提","示","块","有","数学","学公","公式","数","学","公","图片","片自","自适","适应","图","片","自","适","应","移动","动端","端响","响应","应式","移","动","端","响","测试","试完","完成","测","试","完","成","如果","果你","你愿","愿意","如","果","你","愿","意","我可","可以","以帮","帮你","你再","再生","生成","成一","一个","我","可","以","帮","再","生","一","个","专门","门针","针对","专","门","针","对","nextra","的测","试版","的","版","vitepress","极限","限压","压力","力测","极","限","压","力","专测","测样","式崩","崩不","不崩","崩","不","你只","只要","要说","说一","一声","只","要","说","声"]},{"id":"docs-test--文档测试","pageTitle":"","sectionTitle":"文档测试","content":"这里汇集了各种文档功能的测试页面，用于验证 React Docs UI 的渲染能力。","url":"/zh-cn/docs\\test#文档测试","lang":"zh-cn","tokens":["文档","档测","测试","文","档","测","试","这里","里汇","汇集","集了","了各","各种","种文","档功","功能","能的","的测","试页","页面","这","里","汇","集","了","各","种","功","能","的","页","面","用于","于验","验证","用","于","验","证","react","docs","ui","的渲","渲染","染能","能力","渲","染","力"]},{"id":"docs-test--测试页面","pageTitle":"","sectionTitle":"测试页面","content":"MD 测试 - 测试各种 Markdown 语法和功能 KaTeX 测试 - 测试数学公式的完整功能 MDX 演示 - 查看 MDX 组件的使用示例","url":"/zh-cn/docs\\test#测试页面","lang":"zh-cn","tokens":["测试","试页","页面","测","试","页","面","md","试各","各种","各","种","markdown","语法","法和","和功","功能","语","法","和","功","能","katex","试数","数学","学公","公式","式的","的完","完整","整功","数","学","公","式","的","完","整","mdx","演示","演","示","查看","查","看","组件","件的","的使","使用","用示","示例","组","件","使","用","例"]},{"id":"docs--文档","pageTitle":"","sectionTitle":"文档","content":"欢迎使用 React Docs UI 文档系统。","url":"/zh-cn/docs#文档","lang":"zh-cn","tokens":["文档","文","档","欢迎","迎使","使用","欢","迎","使","用","react","docs","ui","档系","系统","系","统"]},{"id":"docs--快速开始","pageTitle":"","sectionTitle":"快速开始","content":"介绍 - 了解 React Docs UI 的核心理念 安装 - 学习如何安装和配置 快速上手 - 在 5 分钟内创建你的第一个文档网站 配置说明 - 深入了解配置选项 PDF Server 部署 - 部署 PDF 生成服务","url":"/zh-cn/docs#快速开始","lang":"zh-cn","tokens":["快速","速开","开始","快","速","开","始","介绍","介","绍","了解","了","解","react","docs","ui","的核","核心","心理","理念","的","核","心","理","念","安装","安","装","学习","习如","如何","何安","装和","和配","配置","学","习","如","何","和","配","置","速上","上手","上","手","在","5","分钟","钟内","内创","创建","建你","你的","的第","第一","一个","个文","文档","档网","网站","分","钟","内","创","建","你","第","一","个","文","档","网","站","置说","说明","说","明","深入","入了","解配","置选","选项","深","入","选","项","pdf","server","部署","部","署","生成","成服","服务","生","成","服","务"]},{"id":"docs--文档测试","pageTitle":"","sectionTitle":"文档测试","content":"MD 测试 - 测试 Markdown 渲染功能 KaTeX 测试 - 测试数学公式渲染 MDX 演示 - 查看 MDX 组件使用示例","url":"/zh-cn/docs#文档测试","lang":"zh-cn","tokens":["文档","档测","测试","文","档","测","试","md","markdown","渲染","染功","功能","渲","染","功","能","katex","试数","数学","学公","公式","式渲","数","学","公","式","mdx","演示","演","示","查看","查","看","组件","件使","使用","用示","示例","组","件","使","用","例"]},{"id":"index--react-docs-ui","pageTitle":"","sectionTitle":"React Docs UI","content":"一个基于 React 的、 配置驱动 的现代化文档网站构建工具。 React Docs UI 旨在让创建美观、功能强大的文档网站变得前所未有的简单。你只需专注于编写 Markdown 文档，其他的一切——从路由、导航到主题切换和命令菜单——都通过简单的 YAML 配置来驱动。","url":"/zh-cn/index#react-docs-ui","lang":"zh-cn","tokens":["react","docs","ui","一个","个基","基于","一","个","基","于","的","配置","置驱","驱动","配","置","驱","动","的现","现代","代化","化文","文档","档网","网站","站构","构建","建工","工具","现","代","化","文","档","网","站","构","建","工","具","旨在","在让","让创","创建","建美","美观","旨","在","让","创","美","观","功能","能强","强大","大的","的文","站变","变得","得前","前所","所未","未有","有的","的简","简单","功","能","强","大","变","得","前","所","未","有","简","单","你只","只需","需专","专注","注于","于编","编写","你","只","需","专","注","编","写","markdown","其他","他的","的一","一切","切—","——","—从","从路","路由","其","他","切","—","从","路","由","导航","航到","到主","主题","题切","切换","换和","和命","命令","令菜","菜单","单—","—都","都通","通过","过简","单的","导","航","到","主","题","换","和","命","令","菜","都","通","过","yaml","置来","来驱","来"]},{"id":"index--核心特性","pageTitle":"","sectionTitle":"核心特性","content":"配置驱动 : 无需编码，通过 site.yaml 定义你的整个网站。 开箱即用 : 极速启动项目，内置所有必需功能。 现代设计 : 优雅的响应式布局，支持明暗主题自动切换。 命令菜单 : 内置 Cmd+K 快捷菜单，快速访问页面。 Markdown 支持 : 全面支持 GFM 和 Frontmatter。 国际化 : 通过配置文件轻松实现多语言支持。","url":"/zh-cn/index#核心特性","lang":"zh-cn","tokens":["核心","心特","特性","核","心","特","性","配置","置驱","驱动","配","置","驱","动","无需","需编","编码","无","需","编","码","通过","通","过","site","yaml","定义","义你","你的","的整","整个","个网","网站","定","义","你","的","整","个","网","站","开箱","箱即","即用","开","箱","即","用","极速","速启","启动","动项","项目","极","速","启","项","目","内置","置所","所有","有必","必需","需功","功能","内","所","有","必","功","能","现代","代设","设计","现","代","设","计","优雅","雅的","的响","响应","应式","式布","布局","优","雅","响","应","式","布","局","支持","持明","明暗","暗主","主题","题自","自动","动切","切换","支","持","明","暗","主","题","自","切","换","命令","令菜","菜单","命","令","菜","单","cmd","k","快捷","捷菜","快","捷","快速","速访","访问","问页","页面","访","问","页","面","markdown","全面","面支","全","gfm","和","frontmatter","国际","际化","国","际","化","过配","置文","文件","件轻","轻松","松实","实现","现多","多语","语言","言支","文","件","轻","松","实","多","语","言"]},{"id":"index--快速开始","pageTitle":"","sectionTitle":"快速开始","content":"只需一个命令，即可拥有你的专属文档网站：","url":"/zh-cn/index#快速开始","lang":"zh-cn","tokens":["快速","速开","开始","快","速","开","始","只需","需一","一个","个命","命令","只","需","一","个","命","令","即可","可拥","拥有","有你","你的","的专","专属","属文","文档","档网","网站","即","可","拥","有","你","的","专","属","文","档","网","站"]},{"id":"index--链接","pageTitle":"","sectionTitle":"链接","content":"指南 : 开始了解 React Docs UI 的所有功能。 GitHub : 查看源码、提交问题或贡献代码。","url":"/zh-cn/index#链接","lang":"zh-cn","tokens":["链接","链","接","指南","指","南","开始","始了","了解","开","始","了","解","react","docs","ui","的所","所有","有功","功能","的","所","有","功","能","github","查看","看源","源码","查","看","源","码","提交","交问","问题","题或","或贡","贡献","献代","代码","提","交","问","题","或","贡","献","代"]}]}

package/template/src/vite-env.d.ts

@@ -1,3 +1,9 @@
-/// <reference types="vite/client" />
-
-
+/// <reference types="vite/client" />
+
+import { Buffer as BufferType } from "buffer";
+
+declare global {
+    interface Window {
+        Buffer: typeof BufferType;
+    }
+}