| English | 한국어 |

A tool to use Notion as a Markdown editor.

⚠️ NOTE: Narkdown is dependent on notion-py, the unofficial Notion API created by Jamie Alexandre. It can not gurantee it will stay stable. If you need to use in production, I recommend waiting for their official release.

pip install narkdown
# pip3 install narkdown

⚠️ NOTE: the latest version of narkdown requires Python 3.5 or greater.

How To Find Your Notion v2 Token - Red Gregory

example.py

python3 example.py

Here is an database template page for importing pages from the database. Move to that page, duplicate it, and test it.

• Import page from Notion and save it to the desired path.

• Import database from Notion and save pages to the desired path.

  • Useful for CMS(Contents Manage System) of static pages such as blog or docs page.

  • Support import by status of content.

  • Support filter contents.

• Import child page in Notion page recursively. And import linked page as a Notion page link.

• Support nested block. (e.g. bulleted, numbered, to-do, toggle)

• Support language selection of code block.

Narkdown provides some configuration for how to extract documents. You can configure Narkdown via narkdown.config.json .

Create narkdown.config.json and run python3 -m narkdown in that directory.

// narkdown.config.json
{
  "exportConfig": {
    "recursiveExport": true,
    "createPageDirectory": true,
    "addMetadata": true,
    "appendCreatedTime": true,
    "generateSlug": true
  },
  "databaseConfig": {
    "categoryColumnName": "Category",
    "statusColumnName": "Status",
    "currentStatus": "✅ Completed",
    "nextStatus": "🖨 Published"
  }
}

The token_v2 of notion is a variable that should not be shared. You can use os environment variable for notion token.

Narkdown use the NOTION_TOKEN as an environment variable for token_v2. Setting this environment variable allow the CLI to omit token_v2 input.

Github action to synchronize the content of the notion database with github.

MIT © younho9