Skip to main content

Export notion page to markdown.

Project description

Notion Markdown Exporter

PyPI version

  • This is Notion Markdown Exporter using notion-py

  • notion2md will export your notion.so page to markdown formatted file.

Updates v1.2.2

  • Supports Inline Math Code in the text block, bulleted list, and numbered list.It will denoted as $$<math code>$$

  • Supports Call export_cli() with token_v2, url, and bmode

Features

  • [New] Token_v2 will be saved after using the exporter, and don't have to enter it next time

  • Converts almost every block in the notion's page to Markdown

  • Downloads images and files in notion's page

  • Exports Nested Pages!

  • Create Front Matters for supporting CMS (Title, Created Date, Tags)

Add "Created" and "Tags" properties in your page. Then exporter will put them in the md file's front matter.

Requirements

  • token_v2: check the way to get Token_v2 in Notion-py Quickstart

Caution Do not share your Token_v2 with others. Others can access your notion page if the token is shared.

  • url: the link that you will export

Installation

pip install notion2md

Usage in Terminal

In your Bash/Zsh terminal,

$python -m notion2md
#Token_v2: <your token_v2 on notion.so>
#Notion Page Url: <your notion page to export>
# Choose you will export the notion page as blog post: [y/n]

This will make <date-page-title>.md file in your directory/notion_output folder.

Usage in Python

from notion2md import *

export_cli(token_v2=<Token_v2>,url=<Notion.so Page's url>,bmode=<0 or 1>)

# Without any parameters will call this prompts
# Token_v2: <your token_v2 on notion.so>
# Notion Page Url: <your notion page to export>
# Choose you will export the notion page as blog post: [y/n]

Output Structure.

The structure of the output looks like this path.

notion2md_output/
├── notion_token.json
└── <main-page-title>/
    ├── <main-page-title>.md
    ├── download/
    │   └── ...
    ├── image/
    │   └── img_1.png
    │   └── ...
    └── subpage/
        └── ...
  • in subpage/, there will be image/, download/, and subpage/ folders if there are sub components in sub page.

Todo

  • convert other block types to md. 

Change Log

Contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

notion2md-1.2.3-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page