Notation

What is Notation?

Notation allows you to write markdown and automatically publish it to Notion. Once it’s in Notion, it can be internal, password protected, personal, or you can ship it as a public website. You also get all of Notion’s AI, search, and formatting for free. It’s designed to keep documentation close to the code, avoiding separate service logins and complex frontend frameworks.

How to use Notation?

Write documentation in markdown, create a Notion page, grab an API key from Notion, put the API key in a ~/.notation/Notation.toml file, and run notation ship –src </path/to/you/docs>.

Notation’s Core Features

Markdown to Notion publishing Automatic subpage creation from directory structure CLI flag support for title and emoji Integration with Notion’s AI, search, and formatting

Notation’s Use Cases

• Publishing documentation to a Notion workspace
• Creating a public website from markdown documentation
• Maintaining documentation alongside code in a repository