工程开发
mintlify avatar

mintlify

维护 Mintlify 文档网站:配置导航栏、管理 MDX 内容、添加组件以及处理 API 参考文档。

简介

Mintlify 技能使代理能够使用 Mintlify 平台构建、组织并维护高质量的文档网站。它专为开发人员、技术文档编写者及产品团队设计,旨在将 MDX 内容转换为专业且易于搜索的文档站点。此技能涵盖了从初步配置到内容组织及部署准备的全生命周期。

  • 网站配置:通过 docs.json 结构管理全局设置,包含主题自定义、品牌标识、颜色及全局集成。
  • 导航策略:实现复杂的网站层级,包含分组、页签、锚点、下拉菜单、产品分段、版本控制及多语言支持。
  • 内容撰写:处理带有 YAML 前置内容 (frontmatter) 的 MDX 页面,并利用 Mintlify 专用组件提升阅读体验。
  • UI/UX 组件:利用内建组件,例如折叠面板 (Accordion)、页签 (Tabs)、步骤 (Steps)、代码组 (CodeGroup)、提示框 (Note, Info, Tip, Warning, Check) 及 API 专用字段 (ParamField, ResponseField)。
  • API 文档:简化将 OpenAPI 规范集成至文档网站的流程,以自动生成交互式 API 参考。
  • 资源管理:协调内部链接、图片路径及项目结构内的静态资源管理。
  • CLI 自动化:执行必要的维护任务,例如通过 Mintlify CLI 进行验证、检查断链 (broken-links) 及进行无障碍检测 (a11y)。

使用注意事项与限制:

  • 请随时参考官方 mintlify.com/docs 以获取最新的组件语法与设置结构。
  • 优先使用内建组件库而非自定义 CSS,以确保平台行为的一致性。
  • 在考虑使用 custom.css 进行排版覆盖前,请务必先检查 docs.json 设置。
  • 确保所有 API 参考皆通过正确配置的 openapi.yml 文件进行链接,以维持与后端实现的同步。
  • 对于大型文档项目,请使用 snippets 处理可重复使用的内容,但应避免过度参数化,以维持代码库的可维护性。
  • 此技能需要 Node.js 环境才能执行如 mint dev, mint validate 及 mint rename 等 CLI 指令。

仓库统计

Star 数
9,494
Fork 数
851
Open Issue 数
533
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年5月1日 06:59
在 GitHub 查看