scopsy / notion-to-md

Convert notion pages, block and list of blocks to markdown (supports nesting)

💡 For better readability and detailed instructions headover to the wiki

Notion to Markdown

Convert notion pages, block and list of blocks to markdown (supports nesting) using notion-sdk-js

Note: Before getting started, create an integration and find the token.

Todo

• heading
• images
• quotes
• links
• bullets
• todo
• inline code
• code block
• strikethrough, underline, bold, italic
• nested blocks
• pages inside pages/child page
• embeds, bookmarks, videos, files (converted to links)
• Simple tables
• divider
• equation block (converted to code blocks)
• convert returned markdown object to string (toMarkdownString())
• typescript support
• add tests

Install

$ npm install notion-to-md

Usage

Note: Details on methods can be found in API section

converting markdown objects to markdown string

This is how the notion page looks for this example:

const { Client } = require("@notionhq/client");
const { NotionToMarkdown } = require("notion-to-md");
// or
// import {NotionToMarkdown} from "notion-to-md";

const notion = new Client({
  auth: "your integration token",
});

// passing notion client to the option
const n2m = new NotionToMarkdown({ notionClient: notion });

(async () => {
  const mdblocks = await n2m.pageToMarkdown("target_page_id");
  const mdString = n2m.toMarkdownString(mdblocks);

  //writing to file
  fs.writeFile("test.md", mdString, (err) => {
    console.log(err);
  });
})();

Output:

converting page to markdown object

Example notion page:

const { Client } = require("@notionhq/client");
const { NotionToMarkdown } = require("notion-to-md");

const notion = new Client({
  auth: "your integration token",
});

// passing notion client to the option
const n2m = new NotionToMarkdown({ notionClient: notion });

(async () => {
  // notice second argument, totalPage.
  const x = await n2m.pageToMarkdown("target_page_id", 2);
  console.log(x);
})();

Output:

[
  {
    "parent": "# heading 1",
    "children": []
  },
  {
    "parent": "- bullet 1",
    "children": [
      {
        "parent": "- bullet 1.1",
        "children": []
      },
      {
        "parent": "- bullet 1.2",
        "children": []
      }
    ]
  },
  {
    "parent": "- bullet 2",
    "children": []
  },
  {
    "parent": "- [ ] check box 1",
    "children": [
      {
        "parent": "- [x] check box 1.2",
        "children": []
      },
      {
        "parent": "- [ ] check box 1.3",
        "children": []
      }
    ]
  },
  {
    "parent": "- [ ] checkbox 2",
    "children": []
  }
]

converting list of blocks to markdown object

same notion page as before

const { Client } = require("@notionhq/client");
const { NotionToMarkdown } = require("notion-to-md");

const notion = new Client({
  auth: "your integration token",
});

// passing notion client to the option
const n2m = new NotionToMarkdown({ notionClient: notion });

(async () => {
  // get all blocks in the page
  const { results } = await notion.blocks.children.list({
    block_id,
  });

  //convert to markdown
  const x = await n2m.blocksToMarkdown(results);
  console.log(x);
})();

Output: same as before

Converting a single block to markdown string

• only takes a single notion block and returns corresponding markdown string
• nesting is ignored
• depends on @notionhq/client

const { NotionToMarkdown } = require("notion-to-md");

// passing notion client to the option
const n2m = new NotionToMarkdown({ notionClient: notion });

const result = n2m.blockToMarkdown(block);
console.log(result);

result:

![image](https://media.giphy.com/media/Ju7l5y9osyymQ/giphy.gif)

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

notion-to-md's Issues

[NV-1327] Test RM issue

test

_{From SyncLinear.com | NV-1327}

gsgs

gsgs content

[NV-1322] test

Update
_NV-1322

Banan

issue

test

fgghgh

[NV-1324] New issue

Content

_NV-1324

[NV-1323] Another test issue

1234

_NV-1323

test

asdasd h

test

asdas

[NV-1330] Test issue

null

_NV-1330

New Test

Contents

anonymous

ttasdas da
asd as
asdas

adfa

asdsadas

test

aaa

Permissions

faf

afafa

test

a

[NV-1331] test issue 4

null

_NV-1331

tata

t

[NV-1325] Test NT

Public

_{From SyncLinear.com | NV-1325}

test

Test issue

test

aaaa

Hello

World