Notation

什么是Notation？

Notation是一个工具，允许您使用Markdown编写文档并自动将其发布到Notion。这使您可以利用Notion的AI功能、搜索功能和格式化选项来编写文档。 它通过使文档靠近代码来简化文档管理，并简化了发布过程。

如何使用Notation？

1. 使用Markdown编写文档。
2. 创建一个Notion页面来托管您的文档。
3. 从Notion获取API密钥。
4. 将API密钥放在~/.notation/Notation.toml文件中。
5. 运行notation ship --src </path/to/you/docs>。
6. 在Notion中查看带有AI搜索和格式的文档。

主要特点：

• Markdown支持： 使用标准Markdown语法编写文档。
• 自动发布： 轻松将您的Markdown文档发布到Notion。
• Notion集成： 利用Notion的AI、搜索和格式化功能。
• 灵活的部署： 将文档保留在内部，以Notion页面的形式发布，或使用Super.so之类的工具将其部署为完整的网站。
• intro.md： 使用intro.md文件将内容直接传送到父页面。
• 参数： 通过Markdown文件中的CLI标志设置页面的标题和表情符号。

为什么Notation很重要？

Notation解决了文档管理中的几个难题：

• 使文档靠近代码，从而促进更好的维护。
• 避免了对单独的文档服务的需求。
• 简化了发布过程。
• 可以利用Notion的强大功能来编写文档。

配置：

要配置Notation，请在notation二进制文件旁边创建一个Notation.toml文件（通常在~/.notation/中）。

## ~/.notation/Notation.toml

[notion]
secret = ""
## 这是将托管您的新文档的页面的标题
parent_page = ""

设置一个Notion帐户，创建一个页面来托管您的文档，并配置集成以开始使用。 完整的文档中提供了详细的说明。 这使任何人都可以轻松地贡献和维护文档。

我在哪里可以使用Notation？

Notation非常适合：

• 需要清晰且可维护的文档的软件项目。
• 使用Notion进行内部知识管理的团队。
• 喜欢使用Markdown编写文档的个人。

使用Notation的最佳方法是什么？

要充分利用Notation，请确保您的Markdown文件结构良好且组织良好。 使用intro.md功能将内容直接添加到父页面。 利用Notion的AI和搜索功能来提高可发现性。