ToolMeshToolMesh
N

Notation

★4.4
💬47
💲Free

Notation simplifies documentation management by allowing users to write in Markdown and publish directly to Notion. It supports internal, password-protected, personal, or public publishing options, leveraging Notion's capabilities for AI, search, and formatting.

💻
Platform
web
APIAutomationCLIDocumentationMarkdownNotionPublishing

What is Notation?

Notation is a tool that converts Markdown files into Notion pages, allowing users to publish documentation internally or publicly while leveraging Notion's AI, search, and formatting features. It keeps documentation close to code, eliminating the need for separate service logins and complex frontend frameworks.

Core Technologies

  • AI
  • Markdown
  • Notion Integration

Key Capabilities

  • Markdown to Notion publishing
  • Automatic subpage creation
  • CLI flag support
  • Integration with Notion's AI, search, and formatting

Use Cases

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

Core Benefits

  • Keeps documentation close to code
  • Avoids separate service logins
  • Uses Markdown for easy formatting
  • Leverages Notion's AI, search, and formatting

Key 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

How to Use

  1. 1
    Write documentation in Markdown
  2. 2
    Create a Notion page
  3. 3
    Grab an API key from Notion
  4. 4
    Put the API key in a ~/.notation/Notation.toml file
  5. 5
    Run notation ship --src </path/to/you/docs>

Frequently Asked Questions

Q.What markdown features do you support?

A.Notation supports headers, paragraphs, code blocks, lists (ordered, unordered), tables, links, images (hosted externally), relative page links, and arbitrary directory structure.

Q.How do I configure Notation?

A.Create a Notation.toml file alongside the notation binary (usually in ~/.notation/). Specify your Notion secret and parent page title in the file.

Q.How do I set all this up?

A.First, have a Notion account. Create a page to host your documentation. Create an integration in Notion and grab the secret. Connect your Notion page to this integration.

Pros & Cons (Reserved)

✓ Pros

  • Keeps documentation close to code
  • Avoids separate service logins for documentation updates
  • Uses Markdown for easy formatting
  • Leverages Notion's AI, search, and formatting capabilities
  • Supports internal and public documentation

✗ Cons

  • Requires a Notion account and API key
  • Needs configuration via a TOML file
  • Images need to be hosted externally

Alternatives

No alternatives found.