Skip to main content

Your first synchronization

In this tutorial, you will learn how to synchronize your markdown files in a Notion page with Mk Notes.

Requirements​

  • A Notion Integration with read-write access on your Notion page
    tip

    Read the official Notion guide to create and setup a Notion Integration on your workspace

Step-by-step guide ☝️​

Step 1: Preview the synchronization result​

Before starting the synchronization, you can preview the result of the synchronization by running the following command:

  mk-notes preview-sync --input <path-where-your-markdown-files-are>

You will see the Notion page architecture that will be generated based on your markdown files.

Step 2: Synchronize your markdown files​

Launch the following command:

  mk-notes sync \
    --input <path-where-your-markdown-files-are> \
    --destination <notion-page-url> \
    --notion-api-token <your-notion-secret>
  • --input : The path where your markdown files are located.
  • --destination : The Notion page URL where you want to synchronize your markdown files.
  • --notion-api-token : Your Notion secret token.

Going further

Mk Notes allows you to customize the created Notion pages directly from your markdown files using frontmatter