Skip to main content

A renderer and uploader for Markdown files to notion

Project description

twitter twitter

Markdown to Notion-py

A renderer and uploader for Markdown files to Notion.so using notion-py

Why use this package?

As of writing, Notion's Markdown importer has some problems:

  • Code fences don't seem to retain their original language or format properly
  • Inline HTML is removed, including iframes
  • Markdown frontmatter is removed
  • Local image references show up as blank images
  • Image alts are loaded as TextBlocks instead of captions
  • Among others...

This package aims to make bulk import much easier by solving the problems above. If you dislike the way this package implements a specific Markdown to Notion conversion or you need extra functionality (like uploading your images to Cloud hosting), you can always subclass NotionPyRenderer (a BaseRenderer for mistletoe) and change it or hook its behavior.

Limitations

  • Currently does not support tables/CollectionViewBlocks

Usage with Python 3.6+

  • pip install md2notion

  • From the command link you can run python -m md2notion.convert [token_v2] [page-url] [...markdown_path_globs]

  • OR In your Python file:

from notion.client import NotionClient
from md2notion.convert import convert

# Follow the instructions at https://github.com/jamalex/notion-py#quickstart to setup Notion.py
client = NotionClient(token_v2="<token_v2>")
page = client.get_block("https://www.notion.so/myorg/Test-c0d20a71c0944985ae96e661ccc99821")

with open("TestMarkdown.md", "r") as f:
    convert(f, page)

Contributing

See CONTRIBUTING.md

Project details


Download files

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

Source Distribution

md2notion-0.0.4.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

md2notion-0.0.4-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file md2notion-0.0.4.tar.gz.

File metadata

  • Download URL: md2notion-0.0.4.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for md2notion-0.0.4.tar.gz
Algorithm Hash digest
SHA256 ecdd5ba5d357cee49a4a92d6a40f28afd7476f88f2a8f16bad1a4b8601057337
MD5 68a74210eedacb00c6ed4e069cdca9b4
BLAKE2b-256 5ad650d7226393d6dfc63d37adf974d3bad7b645d09443013084fb74e6d7d2b7

See more details on using hashes here.

File details

Details for the file md2notion-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: md2notion-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for md2notion-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2c69996d79c1790b40f927e36bd73287e5470aebb36d5681aa80cc8dc6be00cd
MD5 d7eda7110d79ed790ea74b635bba26c1
BLAKE2b-256 6188a4266148903f1574151abb5ca1ff6b7720c514ebb9ce763d4690476bc143

See more details on using hashes here.

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