快速开始
在线查阅
无需任何安装,直接访问站点即可:
- 使用左侧边栏按章节浏览。
- 使用顶部搜索框按关键词检索。
- 点击页面内的链接跳转到相关文档。
本地运行(贡献者)
如果你想在本地预览或编辑文档,按以下步骤操作。
1. 准备环境
- 安装 Node.js 18 或更高版本。
- 安装包管理器,推荐
pnpm:
npm install -g pnpm2. 克隆并安装依赖
git clone https://github.com/locoydata/playbook.gitcd playbookpnpm install3. 启动开发服务器
pnpm dev打开终端提示的地址(通常为 http://localhost:4321),修改 src/content/docs/ 下的 Markdown 文件,浏览器会自动热更新。
4. 构建静态站点
pnpm build产物输出到 dist/ 目录,即部署到 Cloudflare Pages 的内容。
下一步
了解如何新增或修改文档,请阅读 如何贡献。