var Component=(()=>{var m=Object.create;var r=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var u=Object.getPrototypeOf,f=Object.prototype.hasOwnProperty;var C=(n,e)=>()=>(e||n((e={exports:{}}).exports,e),e.exports),b=(n,e)=>{for(var s in e)r(n,s,{get:e[s],enumerable:!0})},o=(n,e,s,h)=>{if(e&&typeof e=="object"||typeof e=="function")for(let l of F(e))!f.call(n,l)&&l!==s&&r(n,l,{get:()=>e[l],enumerable:!(h=y(e,l))||h.enumerable});return n};var B=(n,e,s)=>(s=n!=null?m(u(n)):{},o(e||!n||!n.__esModule?r(s,"default",{value:n,enumerable:!0}):s,n)),v=n=>o(r({},"__esModule",{value:!0}),n);var p=C((D,k)=>{k.exports=_jsx_runtime});var x={};b(x,{default:()=>g});var i=B(p());function E(n){let e={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",span:"span",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...n.components},{Callout:s,File:h,Files:l,Folder:t,Step:d,Steps:a}=e;return s||c("Callout",!0),h||c("File",!0),l||c("Files",!0),t||c("Folder",!0),d||c("Step",!0),a||c("Steps",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(e.p,{children:["The docs module renders MDX from ",(0,i.jsx)(e.code,{children:"content/docs"})," and builds sidebar navigation, powered by ",(0,i.jsx)(e.a,{href:"https://fumadocs.dev/",children:"Fumadocs"})," and ",(0,i.jsx)(e.a,{href:"https://content-collections.dev/",children:"Content Collections"}),". This guide covers scope, entry points, and common config."]}),` `,(0,i.jsx)(e.h2,{id:"fast-edit-path",children:"Fast Edit Path"}),` `,(0,i.jsxs)(a,{children:[(0,i.jsxs)(d,{children:[(0,i.jsx)(e.h3,{id:"toggle-docs-module",children:"Toggle docs module"}),(0,i.jsx)(i.Fragment,{children:(0,i.jsx)(e.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,i.jsxs)(e.code,{children:[(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"// src/config/index.ts"})}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"ui"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" docs"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" enabled"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"true"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"// Set false to redirect /docs/** to home"})]}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})})})]}),(0,i.jsxs)(d,{children:[(0,i.jsx)(e.h3,{id:"docs-alias-and-menu-copy",children:"Docs alias and menu copy"}),(0,i.jsx)(i.Fragment,{children:(0,i.jsx)(e.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,i.jsxs)(e.code,{children:[(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"// src/config/index.ts"})}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"i18n"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" locales"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" en"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" docsAlias"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"Docs"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:","})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" headerMenuMap"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": { "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"docs"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"MVP Docs"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})]}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" zh"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": {"})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" docsAlias"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"\u6587\u6863"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:","})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" headerMenuMap"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": { "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"docs"}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"MVP \u6587\u6863"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})]}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" },"})}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})})})]}),(0,i.jsxs)(d,{children:[(0,i.jsx)(e.h3,{id:"sidebar-structure",children:"Sidebar structure"}),(0,i.jsx)(i.Fragment,{children:(0,i.jsx)(e.pre,{className:"shiki shiki-themes github-light github-dark",style:{"--shiki-light":"#24292e","--shiki-dark":"#e1e4e8","--shiki-light-bg":"#fff","--shiki-dark-bg":"#24292e"},tabIndex:"0",icon:'',children:(0,i.jsxs)(e.code,{children:[(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#6A737D","--shiki-dark":"#6A737D"},children:"// content/docs/meta.en.json"})}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"{"})}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:' "title"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"MuseMVP Docs"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:","})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:' "icon"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"BookOpen"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:","})]}),` `,(0,i.jsxs)(e.span,{className:"line",children:[(0,i.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:' "pages"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:": ["}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"index"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"tech-stack"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"development"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"quick-build"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", "}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:'"cms"'}),(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"]"})]}),` `,(0,i.jsx)(e.span,{className:"line",children:(0,i.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})})}),(0,i.jsx)(s,{type:"info",title:"pages Order",children:(0,i.jsxs)(e.p,{children:["The ",(0,i.jsx)(e.code,{children:"pages"})," array defines left sidebar order. Sub-categories (e.g. ",(0,i.jsx)(e.code,{children:"cms"}),") need a matching ",(0,i.jsx)(e.code,{children:"content/docs/cms/meta.{locale}.json"}),"."]})})]})]}),` `,(0,i.jsx)(e.h2,{id:"doc-organization-rules",children:"Doc Organization Rules"}),` `,(0,i.jsx)(l,{children:(0,i.jsxs)(t,{name:"content/docs",defaultOpen:!0,children:[(0,i.jsxs)(t,{name:"cms",defaultOpen:!0,children:[(0,i.jsx)(h,{name:"cms-docs.en.mdx"}),(0,i.jsx)(h,{name:"cms-blog.en.mdx"}),(0,i.jsx)(h,{name:"meta.en.json"})]}),(0,i.jsx)(h,{name:"index.en.mdx"}),(0,i.jsx)(h,{name:"meta.en.json"})]})}),` `,(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Type"}),(0,i.jsx)(e.th,{children:"Path"}),(0,i.jsx)(e.th,{children:"Description"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Doc content"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"content/docs/**/*.mdx"})}),(0,i.jsxs)(e.td,{children:["Supports ",(0,i.jsx)(e.code,{children:"*.zh.mdx"}),", ",(0,i.jsx)(e.code,{children:"*.en.mdx"})," for i18n"]})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Category meta"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"content/docs//meta.{locale}.json"})}),(0,i.jsx)(e.td,{children:"Sub-category pages and title"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Root meta"}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"content/docs/meta.{locale}.json"})}),(0,i.jsx)(e.td,{children:"Root sidebar order and groups"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:"Icons"}),(0,i.jsxs)(e.td,{children:["frontmatter ",(0,i.jsx)(e.code,{children:"icon"})]}),(0,i.jsxs)(e.td,{children:["Mapped by ",(0,i.jsx)(e.code,{children:"docsSource.icon()"})," to icon components"]})]})]})]}),` `,(0,i.jsx)(e.h2,{id:"config-reference",children:"Config Reference"}),` `,(0,i.jsxs)(e.table,{children:[(0,i.jsx)(e.thead,{children:(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.th,{children:"Config"}),(0,i.jsx)(e.th,{children:"Location"}),(0,i.jsx)(e.th,{children:"Default"}),(0,i.jsx)(e.th,{children:"Effect"})]})}),(0,i.jsxs)(e.tbody,{children:[(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"config.ui.docs.enabled"})}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"src/config/index.ts"})}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"true"})}),(0,i.jsxs)(e.td,{children:["Controls ",(0,i.jsx)(e.code,{children:"/docs/**"})," access; when false, redirects to home"]})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"config.i18n.locales.*.docsAlias"})}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"src/config/index.ts"})}),(0,i.jsxs)(e.td,{children:[(0,i.jsx)(e.code,{children:'"Docs"'})," / ",(0,i.jsx)(e.code,{children:'"\u6587\u6863"'})]}),(0,i.jsx)(e.td,{children:"Docs site title and page title suffix"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"content/docs/meta.{locale}.json"})}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"content/docs"})}),(0,i.jsx)(e.td,{children:"\u2014"}),(0,i.jsx)(e.td,{children:"Left sidebar order and groups"})]}),(0,i.jsxs)(e.tr,{children:[(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"docsSource.icon()"})}),(0,i.jsx)(e.td,{children:(0,i.jsx)(e.code,{children:"src/lib/docs-source.ts"})}),(0,i.jsx)(e.td,{children:"\u2014"}),(0,i.jsxs)(e.td,{children:["Maps frontmatter ",(0,i.jsx)(e.code,{children:"icon"})," to icon component"]})]})]})]}),` `,(0,i.jsx)(e.h2,{id:"adding-a-new-doc",children:"Adding a New Doc"}),` `,(0,i.jsxs)(a,{children:[(0,i.jsx)(d,{children:(0,i.jsxs)(e.p,{children:["Create ",(0,i.jsx)(e.code,{children:"*.zh.mdx"})," and/or ",(0,i.jsx)(e.code,{children:"*.en.mdx"})," under ",(0,i.jsx)(e.code,{children:"content/docs"})," or a subdirectory."]})}),(0,i.jsx)(d,{children:(0,i.jsxs)(e.p,{children:["Add frontmatter: ",(0,i.jsx)(e.code,{children:"title"}),", ",(0,i.jsx)(e.code,{children:"description"}),", ",(0,i.jsx)(e.code,{children:"icon"}),"."]})}),(0,i.jsx)(d,{children:(0,i.jsxs)(e.p,{children:["Register the page path in the ",(0,i.jsx)(e.code,{children:"pages"})," array of the relevant ",(0,i.jsx)(e.code,{children:"meta.{locale}.json"}),"."]})})]}),` `,(0,i.jsx)(e.h2,{id:"related-docs",children:"Related Docs"}),` `,(0,i.jsxs)(e.ul,{children:[` `,(0,i.jsxs)(e.li,{children:[(0,i.jsx)(e.a,{href:"/docs/cms/fumadocs-special-blocks",children:"Fumadocs Special Blocks"})," \u2014 Callout, Cards, Steps, etc."]}),` `,(0,i.jsxs)(e.li,{children:[(0,i.jsx)(e.a,{href:"/docs/cms/cms-blog",children:"Blog Configuration"})," \u2014 Blog toggle and frontmatter"]}),` `,(0,i.jsxs)(e.li,{children:[(0,i.jsx)(e.a,{href:"/docs/cms/paid-content-demo",children:"Paid Content Demo"})," \u2014 isPro and ProContentDivider"]}),` `]})]})}function g(n={}){let{wrapper:e}=n.components||{};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(E,{...n})}):E(n)}function c(n,e){throw new Error("Expected "+(e?"component":"object")+" `"+n+"` to be defined: you likely forgot to import, pass, or provide it.")}return v(x);})(); ;return Component;

Quick Configuration

On this page