这个项目能做什么
Edda 是一个命令行工具,用于构建和发布以 MDX 编写的文档站点,定位为“面向代理的知识文档”,采用 git 原生工作流,在合并时发布。README 将其描述为其平台上每个文档站点(包括 captain.blode.md)所使用的相同方法。
安装通过 npm 全局进行:`npm install -g edda-docs`。快速上手流程为:`edda login` 在浏览器中通过 GitHub 进行身份验证(无需手动管理 API 密钥),`edda new docs --template starter` 将文档站点脚手架生成到某个目录中,`edda dev` 在 localhost:3030 本地提供服务并在编辑时重新加载,`edda push docs` 进行部署。部署后的站点会在其自己的 blode.md 子域名上线,名称、导航和主题取自 `edda new` 生成的 docs.json 文件。
命令集涵盖身份验证(`login`)、脚手架生成(`new`,带有 `minimal` 或 `starter` 模板)、本地预览(`dev`)、配置检查(`validate`)、部署(`push`)、账户列表(`projects`)以及 PostHog 分析管理(`analytics`,带有 `get`、`set posthog <key>`、`unset posthog`)。
对于代理使用,README 记录了一个可安装的斜杠命令,适用于 Claude Code 或任何兼容 skills.sh 的代理,通过 `npx skills add mblode/edda -g --all -y` 安装,之后可以用自然语言驱动脚手架生成和部署,例如 `/edda new my-project --template starter` 和 `/edda push docs/ --project my-project`。
CI 和自动化支持是一个显著重点。环境变量包括 EDDA_API_KEY / BLODEMD_API_KEY(优先于存储的登录会话使用,因此 CI 无需交互式登录)、EDDA_PROJECT / BLODEMD_PROJECT 作为 `--project` 的默认值,以及 EDDA_API_URL / BLODEMD_API_URL 用于 API 源。退出码被记录为稳定且可分支判断:0 成功,1 错误,2 已取消(包括拒绝提示),3 无效输入或配置,4 需要身份验证,5 网络故障。使用 `--json` 时,失败会以单行 stdout 输出,格式为 `{"error":true,"code":"AUTH_REQUIRED","message":"...","hint":"..."}`,README 建议根据稳定的 `code` 字段进行分支判断,而不是面向人的 `message`。
其他说明指出需要 Node.js 24,`push`、`validate` 和 `projects` 接受 `--json`,`push` 从环境中读取项目、API 密钥和分支值以进行非交互式 CI 部署,并且从项目仪表板安装 GitHub App 可在每次推送到分支时启用自动部署。该项目采用 MIT 许可证,作者为 Matthew Blode。
评论
0 人表达喜爱 · 满10人后显示 Deer Point
登录后参与讨论。