Notion2Markdown

Notion2Markdown is a Swift tool used to query select Notion Databases and convert Pages within them to markdown.

Warning

The code in this library has been made public as-is solely for the purposes of reference, education, discovery, and personal use. As such, stability for production applications CANNOT be guaranteed; however, if you're interested in leveraging code within this library in your own projects, feel free to do so at your own risk.

Please open GitHub issues for any problems you encounter or requests you have and we will do my best to provide support.

Features

Notion2Markdown supports converting the following Notion Block types:

• Bookmark
• Bulleted list item
• Callout
• Code
• Columns
• Divider
• Embed
• Equation
• Headings
• Images
• Numbered list item
• Paragraph
• Quote
• Todo

For a full list of Notion block types, visit their API Documentation.

Prerequisites

Create a Notion Integration

In order for Notion2Markdown to have access to your Notion account, you must first set up a new Internal Integration, which can be done on the My Integrations page.

Note: You only need to ensure the Read Content box is checked under the Capabilities for your integration.

Connect a Database to your Integration

Now you need to connect a Database to your new Integration.

Back in the Notion app, go to your Database, select the ⋯ button in the top-right, then select "Connect to" and choose your new Integration. (If your Integration isn't displayed, try refreshing Notion.)

Installation

CLI via Mint

To install notion2markdown and link it globally:

mint install khaptonstall/notion2markdown

Alternatively, you can add notion2markdown to your Mintfile. Running mint boostrap in the same directory will then install all Swift packages in your Mintfile without linking them globally.

In your Mintfile:

khaptonstall/[email protected]

Swift Package Manager

Add the following to your Package.swift dependencies:

// In your dependencies array:
.package(url: "https://github.com/khaptonstall/Notion2Markdown", branch: "main")

// In the desired target or executable:
.executableTarget(
    name: "MyExecutableTarget",
    dependencies: [
        .product(name: "Notion2MarkdownCore", package: "Notion2Markdown"),
    ]
)

CLI Usage

To use notion2markdown, you'll need both your Notion Integration token and the identifier of the Database you wish to search in. (See Notion documentation on how to find your Database ID.) Then you can run the following command:

mint run notion2markdown \
--notion-token <your-notion-token> \
--database-id <your-database-id> \