MkDocs
使用指南

编写文档

组织页面、导航、元数据、链接和资源。

页面结构

每个页面以 frontmatter 开头,后面可以使用标准 Markdown 或 MDX:

---
title: 账单
description: 配置套餐、产品和客户账单。
icon: CreditCard
---

## 创建产品

在这里编写页面内容。

titledescription 用于导航、搜索、元数据和社交分享图。icon 可以填写 Lucide 图标名称。

导航顺序

在目录中使用 meta.json 设置分组名称和页面顺序:

{
  "title": "使用指南",
  "icon": "Blocks",
  "pages": ["authoring", "components", "deployment"]
}

链接和资源

  • 相邻文档页面优先使用相对链接。
  • 可下载文件或静态资源放在 public/,并从根路径引用。
  • 全站通用 React 组件在 press.config.tsx 中注册。

内置输出

每次构建会生成搜索索引、单页 Markdown、llms.txtsitemap.xml 和 Open Graph 图片。发布前更新 src/site.config.ts

最后更新于

本页目录