Agent Skills 文档站如何本地运行并预览修改?
【免费下载链接】agentskillsSpecification and documentation for Agent Skills项目地址: https://gitcode.com/GitHub_Trending/ag/agentskills
如果你打算修改 Agent Skills 的官方文档(错字、表述、示例或新增指南页),按 CONTRIBUTING.md 的贡献流程,改动需要先通过本地预览确认,再提交 PR。这个仓库的文档站基于 Mintlify 构建,源文件都在docs/目录下。下面的步骤讲如何在本仓库里启动本地开发服务器,在http://localhost:3000查看页面,并验证你对 mdx 文件的修改。
准备
- 先把仓库克隆到本地。贡献流程是 fork 仓库、创建分支、提交 PR(见 CONTRIBUTING.md 的 "Submitting Changes"),所以建议先 fork 再克隆你自己的分支。
- 环境里需要 npm/npx:文档给出的启动命令都是 npm 命令。Mintlify CLI 本身不必预先全局安装,用
npx即可运行。
站点的内容和导航都在docs/下:docs.json是站点配置(站点名、导航页、重定向等,见 docs/docs.json),正文页面是home.mdx、specification.mdx、clients.mdx以及skill-creation/、client-implementation/下的 mdx 文件。
启动本地开发服务器
文档给出了两种等价方式,任选其一。
方式一:全局安装 Mintlify CLI 后运行 mint dev
CONTRIBUTING.md 的 "Development Setup" 一节:
# Install Mintlify CLI npm i -g mint # Run local dev server from the docs/ directory cd docs && mint devnpm i -g会把 CLI 装到全局(即向系统全局 node_modules 添加一个包)。装好后每次只需执行第二步。
方式二:在 docs/ 目录下直接运行 npx mint dev
docs/README.md 说明:在docs.json所在的文档根目录执行:
cd docs npx mint dev这种方式不需要全局安装。另外,根目录 package.json 定义了dev脚本,内容就是cd docs && npx mint dev,所以在仓库根目录执行npm run dev也等价于方式二。
预览并验证修改
开发服务器启动后,用浏览器打开http://localhost:3000——这是两处文档给出的本地预览地址。
验证你的改动:
- 修改
docs/下的页面文件。例如修正docs/skill-creation/best-practices.mdx的表述,或调整docs/docs.json里的导航项。 - 在浏览器中访问
http://localhost:3000对应的页面,确认修改已经体现。docs.json的 navigation 中列出的页面条目(如skill-creation/quickstart)对应docs/skill-creation/quickstart.mdx,可按此关系找到要改的文件。
提交与上线
文档给出的完整流程(CONTRIBUTING.md "Submitting Changes"):
- fork 仓库
- 为改动创建分支
- 完成修改并在本地验证
- 提交 PR,保持 PR 聚焦于一个逻辑变更并关联相关 issue
合并后推送到默认分支时,变更会自动部署到线上——docs/README.md 写道:"Changes are deployed to production automatically after pushing to the default branch." 也就是说,http://localhost:3000的本地预览就是你提交 PR 前能做的确认手段。
另外一条硬性要求:如果贡献过程中使用了任何形式的 AI 辅助,必须在 PR 或 issue 中披露 AI 的参与程度(例如"主要由 Claude Code 编写"或"用 ChatGPT 了解代码库但解决方案由本人完成");仅空格或错字的琐碎修改可豁免披露。
【免费下载链接】agentskillsSpecification and documentation for Agent Skills项目地址: https://gitcode.com/GitHub_Trending/ag/agentskills
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考