8 unstable releases (3 breaking)

0.5.1 Feb 19, 2023
0.5.0 Jan 29, 2023
0.4.0 Jan 3, 2023
0.3.4 Dec 9, 2022
0.2.1 Sep 28, 2022

#735 in Encoding

Download history 21/week @ 2024-02-11 5/week @ 2024-02-18 4/week @ 2024-02-25 115/week @ 2024-03-31

115 downloads per month

MIT license

1.5MB
1.5K SLoC

Rust 1.5K SLoC // 0.0% comments Haskell 244 SLoC // 0.2% comments

notion2pandoc

notion2pandoc is a simple CLI tool to convert Notion page to Pandoc AST by using Notion API.

notion2pandoc outputs Pandoc AST serialized in JSON to stdout. Combining with the Pandoc CLI, You can get Notion pages formatted in your favorite markup format supported by Pandoc, as follows.

notion2pandoc -i ${NOTION_PAGE_ID} -s ${NOTION_API_SECRET} | pandoc --from json --to {html,markdown,...}

notion2pandoc outputs pandoc-types-1.23. Validation is done by using Pandoc 3.0.1.

Why NOTION_API_SECRET is needed?

Instead of taking an output of curl or something like that from stdin, notion2pandoc is implemented to take an API secret and call the Notion API internally. This is because the current version of Notion API requires multiple API calls to retrieve the entire page.

The API allows us to retrieve a list of the blocks that make up a page. However, when the number of blocks exceeds 100, the API must be called again with pagination. When a block has child blocks, another API call is necessary to retrieve their contents.

Unsupported features

notion2pandoc simply ignore blocks with following Block Type Object.

  • child_page
  • child_database
  • breadcrumb
  • column
  • column_list
  • template
  • synced_block

notion2pandoc dose not generate table of contents. Instead, you can check if a page contains a block with table_of_contents type by looking at toc value of meta data in generated AST.

License

MIT

Dependencies

~10–23MB
~352K SLoC