共建说明

文档站维护与共建说明

共建说明

这里放的是这套文档站本身的使用说明。

文档更新说明

这篇说明用于描述如何维护当前文档站的目录、分类和内容。

怎么理解目录

当前文档站基于 Fumadocs 与 MDX 文件组织内容。

  • content/docs 是文档内容根目录
  • 每个目录可以通过 meta.json 定义显示标题和页面顺序
  • 每个 .mdx 文件对应一个文档页面

新增一个产品线

  1. content/docs 下新建一个产品线目录。
  2. 给这个目录增加 meta.json
  3. meta.json 里设置 root: true
  4. 新建 index.mdx 作为产品线入口页。
  5. content/docs/meta.json 里把目录加入 pages

新增一篇文档

  1. 找到对应产品线目录。
  2. 新建一个 .mdx 文件。
  3. 在文件顶部写入 frontmatter。
  4. 在对应目录的 meta.json 里加入页面文件名。

示例:

---
title: 示例文档
description: 这里是文档描述
---

# 示例文档

这里写正文内容。

本页内容