跳转到内容
Playbook 知识库

如何贡献

欢迎为知识库贡献内容。所有文档都是 Markdown 文件，存放在仓库的 src/content/docs/ 目录下。

新增一篇文档

  1. 在 src/content/docs/ 下选择合适的目录（如 guide/ 或 rules/），新建 .md 文件。
  2. 在文件顶部添加 frontmatter，至少包含 title 和 description：
---
title: 文档标题
description: 一句话描述，用于搜索与 SEO
---


正文从这里开始……
  1. 用标准 Markdown 编写正文，支持标题、列表、表格、代码块、链接等。

在侧边栏登记

新增文档后，编辑 astro.config.mjs 中 sidebar 对应分组，加入一行：

{ label: '文档标题', link: '/guide/your-new-doc/' }

链接路径与文件路径对应：src/content/docs/guide/your-new-doc.md → /guide/your-new-doc/。

链接写法

  • 站内链接使用绝对路径，结尾带 /，例如 [快速开始](/guide/getting-started/)。
  • 站外链接直接写完整 URL。

提交与发布

  1. 本地预览：pnpm dev，确认排版无误。
  2. 提交改动并推送到 main 分支：
Terminal window
git add .
git commit -m "docs: 新增 xxx 文档"
git push origin main
  1. 推送后 Cloudflare Pages 会自动构建并发布，约 1–2 分钟即可在线查看。

小贴士

  • 发现错别字或过时内容，可直接点页面右上角「在 GitHub 上编辑」在线修改并提 PR。
  • 不确定写法时，参考同目录下已有文档的格式。
  • 相关链接：快速开始、规则总览。