NOTE: Please use the new NPM package at @tryfabric/martian.
Convert Markdown and GitHub Flavoured Markdown to Notion API Blocks and RichText.
Martian is a Markdown parser to convert any Markdown content to Notion API block or RichText objects. It uses unified to create a Markdown AST, then converts the AST into Notion objects.
Designed to make using the Notion SDK and API easier. Notion API version 0.4.5.
- All inline elements (italics, bold, strikethrough, inline code, hyperlinks)
- Lists (ordered, unordered, checkboxes) - to any level of depth
- All headers (header levels >= 3 are treated as header level 3)
- Code blocks
- Block quotes
- Images
- Inline images are extracted from the paragraph and added afterwards (as these are not supported in notion)
- Image urls are validated, if they are not valid as per the Notion external spec, they will be inserted as text for you to fix manually
- Embed images are allowed on specific domains via options.embedUrls. These images are inserted as embed block.
import {markdownToBlocks, markdownToRichText} from '@instantish/martian';
import type {RichText, Block} from '@notionhq/client/build/src/api-types';
const richText: RichText[] = markdownToRichText(`**Hello _world_**`);
// [
// {
// "type": "text",
// "annotations": {
// "bold": true,
// },
// "text": {
// "content": "Hello "
// }
// },
// {
// "type": "text",
// "annotations": {
// "bold": true,
// "italic": true,
// },
// "text": {
// "content": "world"
// }
// }
// ]
const options = { allowUnsupportedObjectType: false, strictImageUrls: true, embedUrls: ['googleusercontent.com'] };
const blocks: Block[] = markdownToBlocks(`
## this is a _heading 2_
* [x] todo list item
`, options);
// [
// {
// "object": "block",
// "type": "heading_2",
// "heading_2": {
// "text": [
// ...
// {
// "type": "text",
// "annotations": {
// "italic": true
// }
// "text": {
// "content": "heading 2"
// }
// },
// ]
// }
// },
// {
// "object": "block",
// "type": "to_do",
// "to_do": {
// "text": [
// {
// "type": "text",
// "annotations": {
// },
// "text": {
// "content": "todo list item"
// }
// }
// ],
// "checked": true
// }
// }
// ]By default, Notion will reject the entire document if you add a block that has an image with an invalid URL (this is not that nice), so by default this will parse in 'Strict Mode' where the image url is parsed, and if not valid, the image is actually parsed as text and added to the document.
In some instances, for example, you are parsing markdown where the image references are local file paths, you may want to allow them to flow through, so that in your client code you can upload the images somewhere and then update the URL paths to point to them before loading into Notion.
Default (strict mode enabled):
const options = { strictImageUrls: true };
const blocks: Block[] = markdownToBlocks(`
`)
// {
// "type": "text",
// "annotations": {
// ...
// },
// "text": {
// "content": "https://image.com/blah"
// }
// }Strict mode disabled:
const options = { strictImageUrls: false };
const blocks: Block[] = markdownToBlocks(`
`)
// {
// "type": "image",
// "image": {
// "url": "https://image.com/blah"
// }
// }tables: Tables can be imported in an unsupported mode if you add a flag to the parser.
First, the default mode - it ignores the tables:
const options = { allowUnsupportedObjectType: false };
const blocks: Block[] = markdownToBlocks(`
# Table
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
`, options);
// [
// {
// "object": "block",
// "type": "heading_1",
// "heading_1": {
// "text": [
// {
// "type": "text",
// "annotations": {
// "bold": false,
// "strikethrough": false,
// "underline": false,
// "italic": false,
// "code": false,
// "color": "default"
// },
// "text": {
// "content": "Table"
// }
// }
// ]
// }
// }
// ]Next, with unsupported flag = true (note the annotations have been removed from the returned object to make it easier to see what is going on):
const options = { allowUnsupportedObjectType: true };
const blocks: Block[] = markdownToBlocks(`
# Table
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
`, options)
[
// {
// "object": "block",
// "type": "heading_1",
// "heading_1": {
// "text": [
// {
// "type": "text",
// "text": {
// "content": "Table"
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table",
// "table": {
// "children": [
// {
// "object": "unsupported",
// "type": "table_row",
// "table_row": {
// "children": [
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "First Header"
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "Second Header"
// }
// }
// ]
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table_row",
// "table_row": {
// "children": [
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "Content Cell"
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "Content Cell"
// }
// }
// ]
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table_row",
// "table_row": {
// "children": [
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "Content Cell"
// }
// }
// ]
// }
// },
// {
// "object": "unsupported",
// "type": "table_cell",
// "table_cell": {
// "children": [
// {
// "type": "text",
// "text": {
// "content": "Content Cell"
// }
// }
// ]
// }
// }
// ]
// }
// }
// ]
// }
// }
// ]Note that if you send this document to Notion with the current version of the API it will fail, but this allows you to pre-parse the blocks in your client library, and do something with the tables. In one example, the tables are being parsed out of the blocks, databases being created, that are then linked back to the imported page: https://github.com/infinitaslearning/notionater/blob/main/index.js#L81-L203
Built with 💙 by the team behind Fabric.
