这个项目能做什么
Blazing Agents 文档网站提供了用于构建生产级代理的全面指南和 API 参考。该网站基于 TanStack Start 和 Fumadocs 构建,包含入门和平台指南、CLI、Python SDK、TypeScript SDK 文档,以及代理、自动化、安全和运营指南。此外,还包括带有协议和资源文档的 REST API 参考。
主要功能包括:
- Blazing Agents 用户的产品指南
- Python 和 TypeScript 的 SDK 文档
- CLI 文档
- 代理、自动化、安全和运营指南
- REST API 参考
仓库结构包括 content/docs/ 用于撰写 MDX 和 Markdown 文档,src-docs/ 用于文档应用程序,public/ 用于静态资产,以及 scripts/ 用于清单生成和构建验证。文档页面在 content/docs/ 下添加或更新,meta.json 文件维护导航顺序。
开发需要 Node.js 24 或更高版本以及 npm。可以使用 npm run dev 本地运行网站,该命令会启动一个开发服务器,监听 localhost:3761。其他可用命令包括 npm run generate 用于创建 Fumadocs 源,npm run build 用于生产构建,npm run typecheck 用于 TypeScript 检查,以及 npm test 用于文档测试。
部署通过 Cloudflare Pages 进行,项目名为 blazing-agents-docs,并与 GitHub 集成。生产分支为 main,构建命令为 npm run build,输出目录为 .output/public。自定义域名为 docs.blazingagents.com。
相关仓库包括 Python SDK、TypeScript SDK、CLI、示例以及 coding-agent 技能。
评论
0 评分人数达到10人后显示
登录后参与讨论。