Notation

Create and manage technical documentation efficiently

访问官方网站

什么是Notation?

Notation 是一款文档工具，允许工程师使用 Markdown 编写文档并在 Notion 中发布，从而便于代码文档管理。

使用 Markdown 编写文档，创建一个 Notion 页面，获取 API 密钥，进行配置，然后运行 Notation 进行发布。

用于文档的 Markdown 编写

与 Notion 的集成发布

内置 AI 搜索和格式化

易于搜索的文档结构

将工程文档发布为公共网站或内部 Notion 页面。

利用 Notion 的 AI 功能增强文档搜索。

Q：

你们支持哪些 Markdown 特性?

A：

我们支持标题、段落、代码块、列表、表格、链接、图片和相对页面链接。

Q：

如何配置 Notation?

A：

在你的 ~/.notation/ 目录中创建一个 Notation.toml 文件，填写所需的 Notion 集成细节。