MuseMVP

Docs 模块用于渲染 content/docs 下的 MDX 文档并生成侧边栏目录树，基于 Fumadocs 与 Content Collections 构建。本文介绍作用、入口与常用配置。

快速改动路径

开关文档模块

// src/config/index.ts
ui: {
  docs: {
    enabled: true,  // 设为 false 则 /docs/** 重定向到首页
  },
}

文档别名与菜单文案

// src/config/index.ts
i18n: {
  locales: {
    en: {
      docsAlias: "Docs",
      headerMenuMap: {
        docs: "MVP Docs",
      },
    },
    zh: {
      docsAlias: "文档",
      headerMenuMap: {
        docs: "MVP 文档",
      },
    },
  },
}

目录组织

// content/docs/meta.zh.json
{
  "title": "MuseMVP 文档",
  "icon": "BookOpen",
  "pages": ["index", "tech-stack", "development", "quick-build", "cms"]
}

pages 顺序

pages 数组决定左侧目录顺序。子分类（如 cms）需有对应的 content/docs/cms/meta.{locale}.json。

文档组织规则

cms-docs.zh.mdx

cms-blog.zh.mdx

meta.zh.json

index.zh.mdx

meta.zh.json

类型	路径	说明
文档正文	`content/docs/*/.mdx`	支持 `.zh.mdx`、`.en.mdx` 多语言
分类目录	`content/docs/<category>/meta.{locale}.json`	子分类的 pages 与 title
站点级目录	`content/docs/meta.{locale}.json`	根目录顺序与分组
图标	frontmatter `icon`	由 `docsSource.icon()` 映射到实际图标组件

底部配置详解

配置项	代码位置	默认值	影响
`config.ui.docs.enabled`	`src/config/index.ts`	`true`	控制 `/docs/**` 是否开放，关闭后重定向首页
`config.i18n.locales.*.docsAlias`	`src/config/index.ts`	`"Docs"` / `"文档"`	文档站标题与页面标题后缀
`content/docs/meta.{locale}.json`	`content/docs`	无	控制左侧目录顺序、分组层级
`docsSource.icon()` 映射	`src/lib/docs-source.ts`	无	frontmatter `icon` 的实际图标与颜色

新增文档步骤

在 content/docs 或子目录下创建 *.zh.mdx、*.en.mdx 文件。

在 frontmatter 中添加 title、description、icon。

在对应 meta.{locale}.json 的 pages 数组中注册页面路径。

快速配置