这个起步模板面向希望从第一天起就让文档站点显得完整、克制又清晰的团队。整体结构刻意保持紧凑,但内容模型已经足够扎实,可以随着真实产品一起成长。

开箱即用的内容

第一版有意把可变项控制得很窄:

  • 位于 / 的品牌落地页
  • 位于 /docs 的指南集合
  • 位于 /reference 的参考集合
  • 使用共享 frontmatter 的 Markdown 页面
  • 自动生成的侧边栏与页内目录
  • 通过 Void output: "static" 模式得到的静态输出

路由地图

路由 作用
/ 介绍这个起步模板,并将访客引导至文档内容。
/docs 说明站点结构与内容编写模型。
/docs/getting-started 介绍项目结构与首次修改方式。
/docs/installation 说明本地安装与依赖选择。
/docs/content-authoring 记录 Markdown 约定与写作习惯。
/docs/guides 展示拥有独立落地页的嵌套文档目录。
/docs/guides/sidebar-nesting 展示嵌套文档分组中的子页面。
/docs/deployment 说明如何构建并发布静态输出。
/reference 介绍偏 API 的参考集合。
/reference/authentication 说明请求的认证预期。
/reference/request-format 展示期望的载荷结构。
/reference/errors 列出错误约定与恢复提示。

内容如何组织

每个内容页面都使用同一份小型 frontmatter 约定:

---
title: Getting Started
description: Launch the starter locally and make your first edit.
section: Start Here
order: 2
---

这些字段已经足够驱动页面标题、说明、分组、侧边栏顺序,以及两个集合中的静态元数据。嵌套文件夹同样可用,因此你也可以把相关页面组织进可折叠的侧边栏分组里。

推荐下一步

当这个起步模板开始贴近你的项目后,后续升级通常都很直接:

  1. 用面向你产品的真实文案替换占位内容。
  2. 当信息架构稳定下来后,再扩展集合或增加专属分区。
  3. 等内容模型真正稳定以后,再加入搜索或版本管理。

如果你想看最实用的第一步,可以继续阅读 Getting Started,或浏览 Reference 概览。