SuperAPI AI 工具集

Notation

Notation 是一个将 Markdown 文档自动发布到 Notion 的命令行工具。它允许开发者直接在代码仓库中编写 Markdown 文档,通过运行命令即可将文档同步到 Notion 页面,从而利用 Notion 内置的 AI、搜索和格式化能力。该工具的设计理念是让文档与代码共存于同一仓库,无需登录额外服务即可更新文档,且不要求使用 React 或部署独立网站。Notation 支持通过命令行参数或 Markdown 前置元数据设置页面标题和图标,支持有序与无序列表、图片(需自托管链接)、相对页面链接以及任意目录结构(自动转换为子页面)。文档可以保留在团队内部 Notion 工作区,也可发布为公开网站。使用时需要 Notion 账户、一个用于托管文档的 Notion 页面,以及在该页面上创建并连接一个内部集成以获取 API 密钥。配置通过 ~/.notation/Notation.toml 文件完成。

访问官网

工具介绍

用途

Notation 是一个将 Markdown 文档发布到 Notion 的命令行工具,核心目标在于让文档与代码同仓库管理。它解决的是“合并与部署代码后,不必登录到独立服务去更新文档”的问题。

主要能力

  • 将 Markdown 文件自动发布到 Notion 页面,并生成对应的子页面结构。
  • 利用 Notion 内置的 AI、搜索和格式化功能,无需自行实现。
  • 支持将文档作为内部知识库(私有 Notion 工作区)或公开页面/网站发布。
  • 支持将内容直接渲染到父页面:如果目录中存在 intro.md 文件,该文件的内容会直接显示在父页面上,而不是创建子页面。
  • 支持 Markdown 文件中以 CLI 标志形式传入的参数:title(页面标题)、emoji(页面图标)。
  • 支持的 Markdown 特性包括:有序列表、无序列表、图片(需自行托管并提供链接)、相对页面链接(指向同仓库其他页面的链接会转换为 Notion 页面链接)、任意目录结构(转换为子页面、子子页面等)。

使用方式

  1. 安装 Notation 二进制文件到 ~/.notation 目录。
  2. 编辑配置文件 ~/.notation/Notation.toml。
  3. 在 Notion 中创建一个页面来托管文档,并记录页面名称。
  4. 在 Notion 中创建内部集成,获取 API 密钥,并填入 Notation.toml。
  5. 将该 Notion 页面连接到新建的集成。
  6. 运行命令:notation ship --src </path/to/you/docs>
  7. 在 Notion 中查看文档,使用内置 AI 搜索、格式化、目录等功能。

详细配置步骤:

  • 注册 Notion 账户并创建用于托管文档的页面,为该页面命名。
  • 在 Notation.toml 中写入该页面名称(需在工作区内唯一)。
  • 在 Notion 的“Settings & members”中进入“Connections”->“Develop or manage integrations”,创建新集成,命名、选择工作区、类型选为 internal。
  • 获取集成密钥(secret),填入 Notation.toml。
  • 返回父级 Notion 页面,点击右上角三个点,进入“Connections”,找到新建的集成并点击连接。

适用场景

  • 开发团队希望将文档与代码放在同一仓库,并遵循相同的评审(review)与 CI 流程。
  • 希望文档更新无需离开代码仓库或登录额外服务。
  • 希望非工程师(如用户、产品经理)也能方便地阅读文档。
  • 希望文档具备高可搜索性,复用 Notion 的搜索能力。
  • 希望在不使用 React、不部署独立网站的前提下,拥有可发布的文档站点。
  • 适用于内部文档管理或对外公开文档发布。

限制

  • 图片不能是本地文件,必须自行托管并提供链接。
  • 需要 Notion 账户,并创建内部集成、配置 API 密钥。
  • 需要具备基本的命令行操作能力。
  • 官方资料未提供关于收费、价格、平台支持范围、具体效果或性能的说明。
  • 官方资料未提供除上述 Markdown 特性之外的其他格式支持说明。