{"repo":"souvikinator/notion-to-md","free":true,"listed":false,"github":"https://github.com/souvikinator/notion-to-md","clone":"git clone https://github.com/souvikinator/notion-to-md.git","description":"Convert Notion pages, blocks, or entire lists into any format: Markdown, MDX, JSX, HTML, LaTeX, and more. A powerful Notion conversion engine that lets you write once in Notion and publish seamlessly anywhere, in any format. Compatible with your favorite CMS, workflow, static site generator, and beyond.","language":"TypeScript","stars":1728,"topics":["exporter","hacktoberfest","markdown","md","nodejs","notion","notion-api","notion-client","notion-convert","notion-database","notion-export","notion-exporter","notion-markdown","notion-to-anything","notion-to-html","notion-to-md","notion2md"],"license":"MIT","category":"content_exporter","readme_excerpt":"\n\n\n

\n
\n\"notion-to-md\n
\n Notion-to-MD\n
\n (Notion to Markdown)\n
\n

\n\n
\n \n \n \n \n \n \n \n \n \n
\n\n

\n Notion-to-MD is a Node.js package that allows you to convert Notion pages to Markdown format. \n

\n

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

\n

\n\"github\n\"twitter\"\n\"repo\n

\n\n## Sponsored\n[![Sponsored by GitAds](https://gitads.dev/v1/ad-serve?source=souvikinator/notion-to-md@github)](https://gitads.dev/v1/ad-track?source=souvikinator/notion-to-md@github)\n\n> [!NOTE]\n> Looking to contribute to v4? Here is the [v4 branch](https://github.com/souvikinator/notion-to-md/tree/v4.0.0-alpha/)\n\n## 🗒️ Recent posts\n\n\n- Apr 23 - [Mastering Media Handling in notion-to-md v4 - Download, Upload, and Direct Strategies](https://notionconvert.com/blog/mastering-media-handling-in-notion-to-md-v4/)\n- Mar 12 - [How to Convert Notion Properties to Frontmatter with notion-to-md v4](https://notionconvert.com/blog/how-to-convert-notion-properties-to-frontmatter/)\n- Mar 12 - [How to Handle Documents in Notion Using notion-to-md v4](https://notionconvert.com/blog/how-to-handle-documents-in-notion-using-notion-to-md-v4/)\n- Mar 11 - [How to Convert Notion Comments to Markdown Footnotes with notion-to-md v4](https://notionconvert.com/blog/how-to-use-notion-comments-as-footnotes-in-markdown/)\n\n\n\n## Looking for Support in Other Languages?\n> If you've created a specific client, please open an issue to have it added here.\n\n- [notion-to-md-py](https://github.com/SwordAndTea/notion-to-md-py) by [@SwordAndTea](https://github.com/SwordAndTea)\n\n## Install\n\n```Bash\nnpm install notion-to-md\n```\n\n## Usage\n> ⚠️ **Note:** Before getting started, create [an integration and find the token](https://www.notion.so/my-integrations).\n> Details on methods can be found in [API section](https://github.com/souvikinator/notion-to-md#api)\n\n> ⚠️ **Note:** Starting from v2.7.0, `toMarkdownString` no longer automatically saves child pages. \n> Now it provides an object containing the markdown content of child pages.\n\n## converting markdown objects to markdown string\n\nThis is how the notion page looks for this example:\n\n\n\n```javascript\nconst { Client } = require(\"@notionhq/client\");\nconst { NotionToMarkdown } = require(\"notion-to-md\");\nconst fs = require('fs');\n// or\n// import {NotionToMarkdown} from \"notion-to-md\";\n\nconst notion = new Client({\n auth: \"your integration token\",\n});\n\n// passing notion client to the option\nconst n2m = new NotionToMarkdown({ notionClient: notion });\n\n(async () => {\n const mdblocks = await n2m.pageToMarkdown(\"target_page_id\");\n const mdString = n2m.toMarkdownString(mdblocks);\n console.log(mdString.parent);\n})();\n```\n\n\n## Separate child page content\n\n**parent page content:**\n\n\n\n**child page content:**\n\n\n\n`NotionToMarkdown` takes second argument, `config`\n\n```javascript\nconst { Client } = require(\"@notionhq/client\");\nconst { NotionToMarkdown } = require(\"notion-to-md\");\nconst fs = require('fs');\n// or\n// import {NotionToMarkdown} from \"notion-to-md\";\n\nconst notion = new Client({\n auth: \"your integration token\",\n});\n\n// passing notion client to the option\nconst n2m = new NotionToMarkdown({ \n notionClient: notion,\n config:{\n separateChildPage:true, // default: false\n }\n });\n\n(async () => {\n const mdblocks = await n2m.pageToMarkdown(\"target_page_id\");\n const mdString = n2m.toMarkdownString(mdblocks);\n \n console.log(mdString);\n})();\n```\n\n**Output:**\n\n`toMarkdownString` returns an object with target page content corresponding to `parent` property and if any child page exists then it's included in the same object.\n\n\n\nUser gets to save the content separately.\n\n## Disable child page parsing\n\n```javascript\n...\n\nconst n2m = new NotionToMarkdown({ \n notionClient: notion,\n config:{\n parseChildPages:false, // default: parseChildPages\n }\n });\n\n...\n```\n\n## converting page to markdown object\n\n**Example notion page:**\n\n\n\n```js\nconst { Client } = require(\"@notionhq/client\");\nconst { NotionToMarkdown } = require(\"notion-to-md\");\n\nconst notion = new Client({\n auth: \"your integration token\",\n});\n\n// passing notion client to the option\nconst n2m = new NotionToMarkdown({ notionClient: notion });\n\n(async () => {\n // notice second argument, totalPage.\n const x = await n2m.pageToMarkdown(\"target_page_id\", 2);\n console.log(x);\n})();\n```\n\n**Output:**\n\n```json\n[\n {\n \"parent\": \"# heading 1\",\n \"children\": []\n },\n {\n \"parent\": \"- bullet 1\",\n \"children\": [\n {\n \"parent\": \"- bullet 1.1\",\n \"children\": []\n },\n {\n \"parent\": \"- bullet 1.2\",\n \"children\": []\n }\n ]\n },\n {\n \"parent\": \"- bullet 2\",\n \"children\": []\n },\n {\n \"parent\": \"- [ ] check box 1\",\n \"children\": [\n {\n \"parent\": \"- [x] check box 1.2\",\n \"children\": []\n },\n {\n \"parent\": \"- [ ] check box 1.3\",\n \"children\": []\n }\n ]\n },\n {\n \"parent\": \"- [ ] checkbox 2\",\n \"children\": []\n }\n]\n```\n\n## converting list of blocks to markdown object\n\n```js\nconst { Client } = require(\"@notionhq/client\");\nconst { NotionToMarkdown } = require(\"notion-to-md\");\n\nconst notion = new Client({\n auth: \"your integration token\",\n});\n\n// passing notion client to the option\nconst n2m = new NotionToMarkdown({ notionClient: notion });\n\n(async () => {\n // get all blocks in the page\n const { results } = await notion.blocks.children.list({\n block_id,\n });\n\n //convert to markdown\n const x = await n2m.blocksToMarkdown(results);\n console.log(x);\n})();\n```\n\n**Output**: same as before\n\n## Converting a single block to markdown string\n\n- only takes a single notion block and returns corresponding markdown string\n- nesting is ignored\n- depends on @notionhq/client\n\n```js\nconst { NotionToMarkdown } = require(\"notion-to-md\");\n\n// passing notion client to the option\nconst n2m = new NotionToMarkdown({ notionClient: notion });\n\nconst result = n2m.blockToMarkdown(block);\nconsole.log(result);\n```\n\n**result**:\n\n```\n![image](https://media.giphy.com/media/Ju7l5y9osyymQ/giphy.gif)\n```\n\n## Custom Transformers\n\nYou can define your own custom transformer for a notion type, to parse and return your own string.\n`setCustomTransformer(type, func)` will overload the parsing for the giving type.\n\n```ts\nconst { NotionToMarkdown } = require(\"notion-to-md\");\nconst n2m = new NotionToMarkdown({ notionClient: notion });\nn2m.setCustomTransformer(\"embed\", async (block) => {\n const { embed } = block as any;\n if (!embed?.url) return \"\";\n return `
\n \n
${await n2m.blockToMarkdown(embed?.caption)}
\n
`;\n});\nconst result = n2m.blockToMarkdown(block);\n// Result will now parse the `embed` type with your custom function.\n```\n\n**Note** Be aware that `setCustomTransformer` will take only the last function for the given type. You can't set two different transforms for the same type.\n\nYou can also use the default parsing by returning `false` in your custom transformer.\n\n```ts\n// ...\nn2m.setCustomTransformer(\"embed\", async (block) => {\n const { embed } = block as any;\n if (embed?.url?.includes(\"myspecialurl.com\")) {\n return `...`; // some special rendering\n }\n return false; // use default behavior\n});\nconst result = n2m.blockToMarkdown(block);\n// Result will now only use custom parser if the embed url matches a specific url\n```\n\n## Contribution\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\nPlease make sure to update tests as appropriate.\n\n## Contributers\n\n\n \n\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n","default_branch":"master","files":18,"tree":[".github/FUNDING.yml",".github/workflows/show-blog-post-rss.yaml",".github/workflows/tweet-on-release.yml",".gitignore",".npmignore","CONTRIBUTING.md","LICENSE","README.md","jest.config.js","package.json","src/index.ts","src/notion-to-md.spec.ts","src/notion-to-md.ts","src/types/index.ts","src/utils/md.spec.ts","src/utils/md.ts","src/utils/notion.ts","tsconfig.json"],"storefront":"/r/souvikinator","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/souvikinator/notion-to-md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}