跳转到内容

快速开始

在线查阅

无需任何安装,直接访问站点即可:

  1. 使用左侧边栏按章节浏览。
  2. 使用顶部搜索框按关键词检索。
  3. 点击页面内的链接跳转到相关文档。

本地运行(贡献者)

如果你想在本地预览或编辑文档,按以下步骤操作。

1. 准备环境

  • 安装 Node.js 18 或更高版本。
  • 安装包管理器,推荐 pnpm:
Terminal window
npm install -g pnpm

2. 克隆并安装依赖

Terminal window
git clone https://github.com/locoydata/playbook.git
cd playbook
pnpm install

3. 启动开发服务器

Terminal window
pnpm dev

打开终端提示的地址(通常为 http://localhost:4321),修改 src/content/docs/ 下的 Markdown 文件,浏览器会自动热更新。

4. 构建静态站点

Terminal window
pnpm build

产物输出到 dist/ 目录,即部署到 Cloudflare Pages 的内容。

下一步

了解如何新增或修改文档,请阅读 如何贡献。