notion-to-md 1.0.2 → 1.0.6

package/README.md

@@ -18,10 +18,12 @@ Convert notion pages, block and list of blocks to markdown (supports nesting) us
 - [x] code block
 - [x] strikethrough, underline, bold, italic
 - [x] nested blocks
-- [ ] embeds
+- [ ] pages inside pages/child page
+- [x] embeds, bookmarks, videos, files (converted to links)
 - [ ] tables
-- [ ] videos
-- [x] convert returned markdown object to string
+- [x] divider
+- [x] equation block (converted to code blocks)
+- [x] convert returned markdown object to string (`toMarkdownString()`)
 - [ ] add tests
 
 ## Install
@@ -51,7 +53,7 @@ const n2m = new notion2md({ notionClient: notion });
 
 (async () => {
   const mdblocks = await n2m.pageToMarkdown("target_page_id");
-  const mdString = n2m.toString(mdblocks);
+  const mdString = n2m.toMarkdownString(mdblocks);
 
   //writing to file
   fs.writeFile("test.md", mdString, (err) => {
@@ -165,10 +167,16 @@ const n2m = new notion2md({ notionClient: notion });
 
 ### Converting a single block to markdown string
 
-- just takes a single notion block and returns corresponding markdown string
+- only takes a single notion block and returns corresponding markdown string
 - nesting is ignored
+- not dependent on @notionhq/client
 
 ```js
+const notion2md = require("notion-to-md");
+
+// notion client not required
+const n2m = new notion2md();
+
 const result = n2m.blockToMarkdown(block);
 console.log(result);
 ```
@@ -181,7 +189,7 @@ console.log(result);
 
 ## API
 
-### `toString(markdownObjects)`
+### `toMarkdownString(markdownObjects)`
 
 - takes output of `pageToMarkdown` or `blocksToMarkdown` as argument
 - convert to markdown string.

package/notion-to-md.js

@@ -3,14 +3,14 @@ const { getBlockChildren } = require("./utils/notion");
 
 class notion2md {
   constructor(options) {
-    if (!options || !options.notionClient)
-      throw new Error(
-        "notion2md takes notion client as argument, for more details check out https://github.com/souvikinator/notion2md"
-      );
-    this.notionClient = options.notionClient;
+    if (!options) {
+      this.notionClient = undefined;
+    } else {
+      this.notionClient = options.notionClient || undefined;
+    }
   }
 
-  toString(mdBlocks = [], nestingLevel = 0) {
+  toMarkdownString(mdBlocks = [], nestingLevel = 0) {
     let mdString = "";
     mdBlocks.forEach((mdBlocks) => {
       if (mdBlocks.parent) {
@@ -19,7 +19,7 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
 `;
       }
       if (mdBlocks.children && mdBlocks.children.length > 0) {
-        mdString += this.toString(mdBlocks.children, nestingLevel + 1);
+        mdString += this.toMarkdownString(mdBlocks.children, nestingLevel + 1);
       }
     });
     return mdString;
@@ -37,6 +37,12 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
    * @returns array of md blocks with their children
    */
   async blocksToMarkdown(blocks, mdBlocks = []) {
+    if (!this.notionClient) {
+      throw new Error(
+        "notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md"
+      );
+    }
+
     for (let i = 0; i < blocks.length; i++) {
       let block = blocks[i];
       if (block.has_children) {
@@ -47,7 +53,7 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
         continue;
       }
       let tmp = this.blockToMarkdown(block);
-      // console.log(">>parsed data=", tmp, block);
+
       mdBlocks.push({ parent: tmp, children: [] });
     }
     return mdBlocks;
@@ -58,6 +64,8 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
    * @returns markdown form of the passed block
    */
   blockToMarkdown(block) {
+    if (!block) throw new Error("notion block required");
+
     let parsedData = "",
       blockContent;
     const { type } = block;
@@ -66,6 +74,23 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
       const image_type = blockContent["type"];
 
       return md.image("image", blockContent[image_type].url);
+    } else if (type === "divider") {
+      return md.divider();
+    } else if (type === "equation") {
+      return md.codeBlock(block[type].expression);
+    } else if (type === "video" || type === "file" || type === "pdf") {
+      blockContent = block[type];
+      const urlType = blockContent["type"];
+
+      return md.link(type, blockContent[urlType].url);
+    } else if (
+      type === "bookmark" ||
+      type === "embed" ||
+      type === "link_preview"
+    ) {
+      blockContent = block[type];
+
+      return md.link(type, blockContent.url);
     } else {
       blockContent = block[type]["text"] || [];
       blockContent.map((content) => {
@@ -80,8 +105,8 @@ ${md.addTabSpace(mdBlocks.parent, nestingLevel)}
       });
     }
 
-    // TODO:  need to take care of escape sequences
-    if (type === "code") parsedData = md.codeBlock(parsedData);
+    if (type === "code")
+      parsedData = md.codeBlock(parsedData, block[type].language);
     if (type === "heading_1") parsedData = md.heading1(parsedData);
     if (type === "heading_2") parsedData = md.heading2(parsedData);
     if (type === "heading_3") parsedData = md.heading3(parsedData);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notion-to-md",
-  "version": "1.0.2",
+  "version": "1.0.6",
   "main": "notion-to-md.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/utils/md.js

@@ -22,8 +22,8 @@ exports.link = (text, href) => {
   return `[${text}](${href})`;
 };
 
-exports.codeBlock = (text) => {
-  return `\`\`\`
+exports.codeBlock = (text, language) => {
+  return `\`\`\`${language}
 ${text}
 \`\`\``;
 };
@@ -41,7 +41,8 @@ exports.heading3 = (text) => {
 };
 
 exports.quote = (text) => {
-  return `| ${text}`;
+  // the replace is done to handle multiple lines
+  return `> ${text.replace(/\n/g, "  \n>")}`;
 };
 
 exports.bullet = (text) => {
@@ -61,3 +62,7 @@ exports.addTabSpace = (text, n = 0) => {
   for (i = 0; i < n; i++) text = tab + text;
   return text;
 };
+
+exports.divider = () => {
+  return "---";
+};

package/utils/notion.js

@@ -1,5 +1,10 @@
 exports.getBlockChildren = async (notionClient, block_id) => {
   try {
+    if (!notionClient) {
+      throw new Error(
+        "notion client is not provided, for more details check out https://github.com/souvikinator/notion-to-md"
+      );
+    }
     const response = await notionClient.blocks.children.list({
       block_id,
     });