Promote Sign in Sign up

Automation

Notation

Markdown to Notion publishing tool with built-in AI, search, and formatting.

Source rating 5.0 (72) 6.3k views 6.3k/mo traffic 0 saves Unknown
Markdown Notion Documentation
More categories (4)
Publishing API CLI Automation
Visit website Sign in to save

Verdict

A quick read before you dig into the full page.

Best if
You are engineers and need: Publishing documentation to a Notion workspace
Pick this when
Markdown to Notion publishing tool with built-in AI, search, and formatting

Overview

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.

Notation screenshot

Best for

Short scenarios where Notation tends to shine.

  • Publishing documentation to a Notion workspace

    Best for Engineers

  • Creating a public website from markdown documentation

    Best for Technical writers

  • Maintaining documentation alongside code in a repository

    Best for Product managers

Example outputs 1

Sample generations and before/after results for Notation.

Notation screenshot
Notation screenshot

Access & connections

Where you can use Notation, and what it plugs into.

Platforms

CLI

Integrations

Notion

Capabilities

What this tool accepts, produces, and is strongest at.

Highlights

  • 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

People also view

Tools that often show up alongside Notation in collections and comparisons.

FAQ 5

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>.
What markdown features do you support?
Notation supports headers, paragraphs, code blocks, lists (ordered, unordered), tables, links, images (although not local, you need to host yourself and put the link), relative page links (to other pages in the same repo, which will turn into Notion page links), and arbitrary directory structure (will turn into subpages, subsubpages, etc.).
How do I configure Notation?
Create a Notation.toml file alongside the notation binary (usually in ~/.notation/). In the file, specify your Notion secret and parent page title.
How do I set all this up?
First, you need to have a Notion account. Next, you need to create a page to host your documentation. Then, create an integration in Notion and grab the secret. Finally, connect your Notion page to this integration.
Notation
Visit website