说明目录
Garden 使用说明快速上手

用 AI 写作

用编辑器插件插入想法并预览，交给 Agent 编译；提交前由同一个脚本检查。

在 Garden 里写图表、指标或交互组件不用记标签语法。你在正文写一句自然语言想法，Agent 按站点里的 skill 把它编译成组件，提交时再由同一套命令检查。

人和 Agent 用同一套工具

Agent 找块用 npx garden ui scan，写回用 npx garden ui apply，自查用 npx garden ui check；作者提交时 pre-commit 钩子运行的也是 npx garden ui check。检查失败时给出的技能调用短指令，就是发给 Agent 的下一步。

1. 写一句想法

在想放组件的位置写一个 garden compose 围栏，只写想让读者做什么、看到什么，不用写组件名：

```garden compose
让读者拖动每天写的字数和每周写几天，看写完一篇 8000 字的长文要几周。
```

未编译的想法使用同一个 garden compose 入口。npx garden ui check 和 npx garden check 对草稿与已发布稿件都检查并报告 compose-uncompiled。Agent 在 Compose 内组合正文、资源、图形和交互；如果一段普通文字更清楚，也可以直接写回段落。

2. 随包安装的两个 skill

两个 skill 存放在站点根目录的 .agents/skills/ 下。npx hd-garden init 建站时会自动安装，首次运行 npx garden sync 或 npx garden dev 时会递归更新引擎管理的 skill（本地修改先备份到 .garden/skill-backups/），运行 npx garden skill 可手动重装。

Skill 名称触发话术示例执行操作
garden-compose「编译这篇：content/posts/writing-pace.md」「重编译 writing-pace」或直接粘贴修复提示词扫描 uncompiled、error 状态的块，按规则生成组件并用 npx garden ui apply 写回；说「这篇哪里适合交互」则进入只读建议模式，最多挑出 5 处可直接粘贴的想法草稿
garden-post-review「审稿：content/posts/writing-pace.md」先修 npx garden check 报出的结构错误，再按图表规范修交互块，最后通读全文只给修改建议而不改稿

3. garden ui 子命令与整篇检查

garden ui 下的子命令供作者和 Agent 共用；想法块没有 id 时，npx garden ui apply 用 npx garden ui scan 输出的 --intent-hash（或行号 --at）定位。

命令作者何时使用Agent 何时使用
npx garden ui scan <稿件.md>查看文内有哪些待编译或报错的块第一步：读取每块的 status、startLine、hash 和 intentHash
npx garden ui prompt [--studio]查看组件目录、设计规则与配方示例编写组件前必读，只使用目录里存在的组件与属性
npx garden ui schema查看组件目录的 JSON 定义需要结构化读取组件属性约束时调用
npx garden ui apply <稿件.md> --id <id>日常手写一般不用按 --id、--intent-hash 或 --at 替换单个围栏，围栏外逐字节不变
npx garden ui check <稿件.md>提交前钩子自动运行（也可传 --staged 或 --all）写回后自查，直到退出码为 0
npx garden ui catalog [--out 文件] [--no-open]在 .garden/ui-catalog.html 生成离线组件清单并在浏览器查看一般不用
npx garden check <稿件.md>单独检查一篇文章的标题、图片与全部围栏全部块写回后的收尾检查，确认输出 JSON 的 ok 为 true

4. 提交前检查与修复提示词

首次运行 npx garden sync 或 npx garden dev 时，Garden 会在 .git/hooks/pre-commit 写入 exec npx --no-install garden ui check --staged --quiet（若已有其他钩子则不覆盖，只提示需添加的命令）。--staged 直接通过 git show :<路径> 读取暂存区内容，失败时输出文件行号、诊断码和调用项目技能的短指令：

content/posts/writing-pace.md:9  -  compose-uncompiled  还有没编译的 compose 想法

请调用 garden-compose skill（.agents/skills/garden-compose/SKILL.md），修复以上错误块后重新校验。
  • 默认只给出文件、行号、错误码和调用项目 garden-compose skill 的短指令。不写提示词文件、不复制剪贴板、不调用模型；已有提示词文件保持不变。
  • 只有确需独立导出时，显式运行 npx garden ui check <稿件.md> --out .garden/export.md --standalone。--standalone 仅为导出文件附加完整规则，单独使用不会创建文件。
  • 交互块里写错标签名（如把 <Slider> 写成 <Slidr>）也会报 ui-component 并指到具体行号。
  • 需要重装钩子时运行 npx garden hooks（加 --force 覆盖已有钩子）；不想自动安装钩子时设置 GARDEN_SKIP_HOOKS=1。

5. 用一句话生成代码对比

在改好的完整代码块正下方放一个 garden 想法块，用一句话写出它和上一版相比改了什么：

```yaml
pages:
  garden:
    title: "用 Markdown 写丨推送之后网站自己更新"
```

```garden compose
和上一版比：标题原来用句号和换行分两行，现在改成用「丨」分行。
```

Agent 按 garden-compose skill 会把这个想法块替换成一段紧挨着完整代码的 diff 围栏。页面渲染时会把完整代码和 diff 合成一个带「代码 / 对比上一版」切换按钮的代码框，手写 diff 的规则见 写文章与随想。

6. 在编辑器里插入、预览，再交给 skill 编译

VS Code、Cursor 和 Typora 的 Intelligent UI 插件把上面的流程放到写稿的地方。插件随 hd-garden 发布。npx hd-garden init 把产物复制到 .garden/editors/，并在交互终端里询问要不要安装。第一次 npx garden sync 如果还没问过，会再问一次。非交互环境、CI=1 或 GARDEN_SKIP_EDITORS=1 只打印提示，不阻塞。手动安装：

npx garden editors install
npx garden editors install --yes
npx garden editors install --vscode
npx garden editors install --typora

装好之后，一篇组件通常是这四步：

  1. 插入想法。 在要放组件的位置运行「插入 Garden 块」（VS Code / Cursor 的快捷键是 macOS Cmd+Alt+I，Windows / Linux Ctrl+Alt+I）。Typora 里输入 / 后选 /garden，下一层列表每一项有一张小预览图；命令的快捷键在 Windows / Linux 是 Ctrl+Alt+I，macOS 需要在「设置 → 快捷键」里自己录。插入的是给 garden-compose skill 编译的想法围栏，例如选「资源卡」得到：

    ```garden compose
做成资源卡。一篇论文、一个仓库或一本书，读者需要标题、链接和一句说明。请写上链接、标题、一句说明。
```

  2. 预览。 打开 Markdown 预览，或在 Typora 里把光标移出围栏。intent 显示成想法卡片；skill 写回 ui 之后，预览画成和博客一样的组件。错误会标在源码上（VS Code / Cursor 的「问题」面板和 CodeLens）。

  3. 看清单。 命令「查看组件清单」，或在终端运行 npx garden ui catalog 打开 .garden/ui-catalog.html。清单里的「用它开始」把配方插进当前稿件，适合已经知道要用哪一种组件的时候。

  4. 编译。 「复制编译提示词」。中文站点得到 编译这篇：<相对路径>，英文站点得到 Compile this post: <相对路径>。把这句话发给 garden-compose skill。Agent 用 npx garden ui scan 定位，用 npx garden ui prompt 读规则，用 npx garden ui apply 写回。插件不调用模型。

Typora 的前提。 先安装 typora-community-plugin。npx garden editors install --typora 把插件复制到 ~/.typora/community-plugins/plugins/hedon954.garden-intelligent-ui/（macOS 同时写到 ~/Library/Application Support/abnerworks.Typora/plugins/plugins/hedon954.garden-intelligent-ui/），然后在「设置 → 已安装插件」里勾选 Garden Intelligent UI。升级 Typora 会覆盖社区框架，需要重装框架后再勾选。没找到 code 或 cursor 时，用扩展视图的 Install from VSIX 选择 .garden/editors/vscode/ 里的文件。安装细节见 语法检查与快捷输入。

7. 不使用 Agent 时的快捷输入

不借助 AI 手写组件时，可以直接使用包内自带的模板与代码片段：

  • make new 创建的草稿底部自带一段 <!-- 组件速查 ... --> 注释，包含想法块和各个组件的示例，写完可直接删掉。
  • templates/garden-blocks.md 提供统一 Compose 入口的示例；macOS 与 Typora / Alfred 用户可导入 templates/garden-snippets.plist，输入 ;gcompose 展开带一句白话的 Compose 围栏。
  • 编辑器插件的用法见上一节。npx garden ui catalog 在本地生成 .garden/ui-catalog.html 离线组件画廊。

8. 可选的独立管理后台

Garden 引擎仓库内置了可选的 /admin 管理后台（位于 app/admin 与 worker/），可通过 npm run admin:local、npm run admin:cloudflare 或 Docker 单独部署。配置环境变量后，后台提供以下网页端功能：

  • 通过 GitHub OAuth 登录（仅允许 ADMIN_GITHUB_LOGINS 白名单中的用户），在网页端编写随想并用 CONTENT_GITHUB_TOKEN 直接提交为 content/thoughts/*.md，图片与音视频通过十分钟有效的 Post Policy 直传阿里云 OSS。
  • 在 /admin/ui/blocks 查看仓库内全部稿件（含草稿）的交互块状态，一键复制与命令行钩子相同的修复提示词。
  • 在 /admin/ui 组件工作台用自然语言试写或手改组件（配置 UI_MODEL_BASE_URL、UI_MODEL_API_KEY、UI_MODEL_NAME），在 /admin/ui/catalog 浏览组件清单，在 /admin/preview/<路径> 预览未发布草稿，以及在 /admin/ui/evals 运行模型自检。
目录