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.
- 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)
- tables
- divider
- equation block (converted to code blocks)
- convert returned markdown object to string (
toMarkdownString()
) - add tests
$ npm install notion-to-md
This is how the notion page looks for this example:
const { Client } = require("@notionhq/client");
const notion2md = require("notion-to-md");
const notion = new Client({
auth: "your integration token",
});
// passing notion client to the option
const n2m = new notion2md({ 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:
This is how the notion page looks for this example:
const { Client } = require("@notionhq/client");
const notion2md = require("notion-to-md");
const notion = new Client({
auth: "your integration token",
});
// passing notion client to the option
const n2m = new notion2md({ notionClient: notion });
(async () => {
const x = await n2m.pageToMarkdown("target_page_id");
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": []
}
]
This example blocks from a single page is used. One construct array of blocks from different notion pages and pass in to the
blocksToMarkdown()
same notion page as before
const { Client } = require("@notionhq/client");
const notion2md = require("notion-to-md");
const notion = new Client({
auth: "your integration token",
});
// passing notion client to the option
const n2m = new notion2md({ 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
- only takes a single notion block and returns corresponding markdown string
- nesting is ignored
- not dependent on @notionhq/client
const notion2md = require("notion-to-md");
// notion client not required
const n2m = new notion2md();
const result = n2m.blockToMarkdown(block);
console.log(result);
result:
![image](https://media.giphy.com/media/Ju7l5y9osyymQ/giphy.gif)
- takes output of
pageToMarkdown
orblocksToMarkdown
as argument - convert to markdown string.
- Takes page_id as input and converts all the blocks in the page to corresponding markdown
- Uses
blocksToMarkdown
internally.
- Takes one notion block and converts to markdown
- does not deal with nested notion blocks
- This method doesn't require the
notion-sdk-js
. - Refer docs to know more about notion blocks
Note: requires notion-sdk-js unlike
blockToMarkdown
blocks
: array of notion blocks- deals with nested blocks
- uses
blockToMarkdown
internally.
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.