notion-to-md 1.0.0 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Souvik Kar Mahapatra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,7 +2,7 @@
 
 # Notion to Markdown
 
-Notion Markdown Exporter using **[notion-sdk-js](https://github.com/makenotion/notion-sdk-js)**
+Convert notion pages, block and list of blocks to markdown (supports nesting) using **[notion-sdk-js](https://github.com/makenotion/notion-sdk-js)**
 
 > **Note:** Before getting started, create [an integration and find the token](https://www.notion.so/my-integrations).
 
@@ -18,10 +18,12 @@ Notion Markdown Exporter using **[notion-sdk-js](https://github.com/makenotion/n
 - [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
-- [ ] 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
@@ -32,7 +34,39 @@ $ npm install notion-to-md
 
 ## Usage
 
-### converting page to markdown
+### converting markdown objects to markdown string
+
+This is how the notion page looks for this example:
+
+![Imgur](https://imgur.com/O6bKCmH.png)
+
+```js
+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:**
+
+![output](https://imgur.com/XrUYrZ0.png)
+
+### converting page to markdown object
 
 This is how the notion page looks for this example:
 
@@ -40,7 +74,7 @@ This is how the notion page looks for this example:
 
 ```js
 const { Client } = require("@notionhq/client");
-const notion2md = require("notion2md");
+const notion2md = require("notion-to-md");
 
 const notion = new Client({
   auth: "your integration token",
@@ -100,7 +134,7 @@ const n2m = new notion2md({ notionClient: notion });
 ]
 ```
 
-### converting list of blocks to markdown
+### converting list of blocks to markdown object
 
 > This example blocks from a single page is used. One construct array of blocks from different notion pages and pass in to the `blocksToMarkdown()`
 
@@ -108,7 +142,7 @@ same notion page as before
 
 ```js
 const { Client } = require("@notionhq/client");
-const notion2md = require("notion2md");
+const notion2md = require("notion-to-md");
 
 const notion = new Client({
   auth: "your integration token",
@@ -131,7 +165,7 @@ const n2m = new notion2md({ notionClient: notion });
 
 **Output**: same as before
 
-### Converting a single block to markdown
+### Converting a single block to markdown string
 
 - just takes a single notion block and returns corresponding markdown string
 - nesting is ignored
@@ -149,9 +183,15 @@ console.log(result);
 
 ## API
 
+### `toMarkdownString(markdownObjects)`
+
+- takes output of `pageToMarkdown` or `blocksToMarkdown` as argument
+- convert to markdown string.
+
 ### `pageToMarkdown(page_id)`
 
 - Takes page_id as input and converts all the blocks in the page to corresponding markdown
+- Uses `blocksToMarkdown` internally.
 
 ### `blockToMarkdown(block)`
 

package/notion-to-md.js

@@ -10,6 +10,21 @@ class notion2md {
     this.notionClient = options.notionClient;
   }
 
+  toMarkdownString(mdBlocks = [], nestingLevel = 0) {
+    let mdString = "";
+    mdBlocks.forEach((mdBlocks) => {
+      if (mdBlocks.parent) {
+        mdString += `
+${md.addTabSpace(mdBlocks.parent, nestingLevel)}
+`;
+      }
+      if (mdBlocks.children && mdBlocks.children.length > 0) {
+        mdString += this.toMarkdownString(mdBlocks.children, nestingLevel + 1);
+      }
+    });
+    return mdString;
+  }
+
   async pageToMarkdown(id) {
     if (!id) throw new Error("pageToMarkdown takes page_id as argument");
     const blocks = await getBlockChildren(this.notionClient, id);
@@ -32,7 +47,7 @@ class notion2md {
         continue;
       }
       let tmp = this.blockToMarkdown(block);
-      // console.log(">>parsed data=", tmp, block);
+
       mdBlocks.push({ parent: tmp, children: [] });
     }
     return mdBlocks;
@@ -51,6 +66,23 @@ class notion2md {
       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) => {
@@ -65,7 +97,6 @@ class notion2md {
       });
     }
 
-    // TODO:  need to take care of escape sequences
     if (type === "code") parsedData = md.codeBlock(parsedData);
     if (type === "heading_1") parsedData = md.heading1(parsedData);
     if (type === "heading_2") parsedData = md.heading2(parsedData);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "notion-to-md",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.0.4",
+  "main": "notion-to-md.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/utils/md.js

@@ -23,7 +23,9 @@ exports.link = (text, href) => {
 };
 
 exports.codeBlock = (text) => {
-  return `\`\`\`${text}\`\`\``;
+  return `\`\`\`
+${text}
+\`\`\``;
 };
 
 exports.heading1 = (text) => {
@@ -54,4 +56,12 @@ exports.image = (alt, href) => {
   return `![${alt}](${href})`;
 };
 
-//TODO: embed and fluid tags
+exports.addTabSpace = (text, n = 0) => {
+  const tab = "	";
+  for (i = 0; i < n; i++) text = tab + text;
+  return text;
+};
+
+exports.divider = () => {
+  return "---";
+};