Skip to content

文档管理

创建文档

docs/ 目录下创建 .md 文件即可添加新文档:

bash
# 创建新指南文档
touch docs/guide/new-page.md

编写文档

使用 Markdown 语法编写内容:

markdown
# 页面标题

正文内容...

## 二级标题

### 三级标题

Frontmatter

每个页面顶部可以添加 Frontmatter 元数据:

markdown
---
title: 页面标题
description: 页面描述
layout: doc
sidebar: false      # 隐藏侧边栏
aside: false        # 隐藏右侧大纲
---

文档分类

通过目录结构对文档进行分类:

docs/
├── guide/          # 使用指南
├── api/            # API 文档
├── tutorial/       # 教程
└── faq.md          # 常见问题

添加到侧边栏

config.mtssidebar 中添加新文档:

ts
sidebar: {
  '/guide/': [
    {
      text: '入门',
      items: [
        { text: '新页面', link: '/guide/new-page' }
      ]
    }
  ]
}

文档排序

侧边栏中文档的顺序由配置中 items 数组的顺序决定。

最近更新