Notation
Documentation tooling for engineers
Listed in categories:
Developer ToolsWritingGitHub
Description
Notation is a tool that allows you to write documentation in Markdown and automatically publish it to Notion. It integrates seamlessly with Notion, enabling you to manage your documentation alongside your code without the need for separate services. Notation emphasizes a design philosophy where documentation lives with the code, is easily accessible, and is subject to the same review processes as code.
How to use Notation?
To use Notation, write your documentation in Markdown, create a Notion page to host it, grab an API key from Notion, and configure your Notation.toml file. Finally, run the command 'notation ship src pathtoyoudocs' to see your documentation in Notion.
Core features of Notation:
1️⃣
Write documentation in Markdown
2️⃣
Automatically publish to Notion
3️⃣
Supports internal and public documentation
4️⃣
Utilizes Notion's AI search and formatting
5️⃣
Deployment options for internal or public access
Why could be used Notation?
| # | Use case | Status | |
|---|---|---|---|
| # 1 | Creating internal documentation for teams | ✅ | |
| # 2 | Publishing public documentation for products | ✅ | |
| # 3 | Managing documentation alongside code in a repository | ✅ | |
Who developed Notation?
Notation is developed by a team focused on simplifying the documentation process for developers and non-developers alike. They prioritize integration with existing tools and a user-friendly experience.