Notation Howto
Notation is a tool that automatically publishes Markdown documentation to Notion, enabling seamless integration of docs with code repositories.
View MoreHow to Use Notation
Install Notation: Run the installation command: curl -sSL https://github.com/kristian1108/notation/raw/master/install.sh | bash
Create a Notion account: Sign up for a Notion account at https://www.notion.so/ if you don't already have one
Create a parent page in Notion: Create a new page in Notion that will host your documentation
Create a Notion integration: Go to Settings & Members > Connections > Develop or manage integrations. Create a new internal integration and copy the secret key
Configure Notation: Create a Notation.toml file in ~/.notation/ with your Notion secret and parent page name
Connect integration to page: On your Notion parent page, go to ... > Connections and add your new integration
Write documentation: Write your documentation in Markdown format
Ship documentation: Run the command: notation ship --src </path/to/your/docs> to publish your documentation to Notion
View in Notion: Check your Notion page to see the published documentation with formatting, search, and AI features
Notation FAQs
Notation is a tool that allows you to write documentation in Markdown and automatically publish it to Notion. It enables you to keep documentation with your code repository while leveraging Notion's features like AI search and formatting.
Popular Articles
Best AI Chatbot in September 2024
Sep 14, 2024
Runway's Gen 3 Alpha Video-to-Video : AI-Powered Video Editing Breakthrough Launches Today
Sep 14, 2024
OpenAI Releases Revolutionary GPT-o1 Model with Enhanced Reasoning Capabilities
Sep 14, 2024
PixVerse V2.5 Hugging Video Tutorial | How to Create AI Hug Videos in September 2024
Sep 13, 2024
View More