如需了解 Mintlify 产品知识(组件、配置、写作标准), 请安装 Mintlify 技能:
npx skills add https://mintlify.com/docs
文档项目说明¶
它是什么¶
这是 Macro 面向客户的文档站点,托管于 docs.macro.com,基于 Mintlify 构建。它涵盖面向终端用户的托管产品,以及 AI 界面所暴露的 MCP 工具参考页面。
关于本项目¶
- 页面是带有 YAML frontmatter 的 MDX 文件
- 配置位于
docs.json - 运行
mint dev可在本地预览 - 运行
mint broken-links可检查链接 - 品牌样式与 macro.com 保持一致:颜色和自托管字体(
fonts/)在docs.json中设置,style.css用于覆盖 Mintlify 配置无法触及的 Mintlify 默认样式 AI/mcp/tools/下的 MCP 工具参考页面由scripts/generate-mcp-tool-pages.ts根据crates/ai_tools中的当前 MCP 注册表(gen_tool_schemas --mcp)生成;历史前端 schema 不得作为公共文档的内容来源——应修复生成器或 schema,而不是修改输出
术语¶
- 在 UI 文案、AI 工具和文档中,将表单的条件答案检查称为 gate
- block 是 Macro 中的核心单元(doc、email、channel、task、call、canvas 等)。请使用 "block",而不是 "module" 或 "app"
- 对于使用
@创建的引用,请使用 @mention(而不是 "at-mention" 或 "tag") - 使用 channel(而不是 "chat room")、agent(而不是 "bot"),并用 workspace 指代用户的整个 Macro 环境
- 使用 personal memory 和 team memory 来表示两个记忆层级
- 在指代收件箱和电子邮件视图时,Signal 和 Noise 需要大写
- 第三方产品使用其官方大小写形式:GitHub、Gmail、Notion、Slack
风格偏好¶
- 使用主动语态和第二人称("you")
- 保持句子简洁——每句话只表达一个想法
- 标题使用 sentence case(句首大写)
- UI 元素使用粗体:点击 Settings
- 文件名、命令、路径和代码引用使用代码格式
- 键盘快捷键使用
<kbd>标签,例如按 c + t - 截图存放在
images/中,需要描述性的 alt text——绝不要使用文件名
内容边界¶
- 记录托管产品;自托管仅在 FAQ 中进行高层级说明
- 不要记录内部工具、基础设施细节或未发布的功能
- 不要添加占位页面或 "WIP" 页面——只有在有真实内容时才添加页面
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro