需求人群
Notation主要面向需要编写和维护技术文档的开发者和工程师。它通过简化文档的编写和发布流程,使得非技术背景的用户也能轻松阅读和理解技术文档。此外,Notation的集成方式使得团队成员可以更加集中精力于代码开发,而不必分散注意力去管理文档。
使用场景
技术团队使用Notation将项目文档与代码库同步更新。产品团队利用Notation创建易于搜索和阅读的产品手册。教育机构使用Notation发布课程资料和学习指南。
产品特色
使用Markdown编写文档,自动同步到Notion。支持Markdown的多种功能,如标题、段落、代码块、列表、表格、链接和图片。文档在Notion中可以作为内部资源或公开网站。利用Notion的AI搜索功能,提高文档的可搜索性。文档更新无需登录其他服务,与代码库同步。支持将特定内容直接发布到Notion的父页面。支持通过命令行参数自定义Notion页面的标题和图标。
使用教程
11. 安装Notation插件到本地环境。22. 在Notion中创建一个页面,用于托管文档。33. 从Notion获取API密钥,并将其添加到Notation配置文件中。44. 使用Notation命令行工具将Markdown文档发布到Notion页面。55. 在Notion中查看格式化后的文档,并利用其内置搜索和目录功能。66. 根据需要,可以选择将文档保留在Notion工作空间内部,或部署为公开网站。