notion-to-md 1.0.0

package/README.md

@@ -0,0 +1,178 @@
+<img src="https://imgur.com/WgXdz9r.png" />
+
+# Notion to Markdown
+
+Notion Markdown Exporter 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).
+
+## Todo
+
+- [x] heading
+- [x] images
+- [x] quotes
+- [x] links
+- [x] bullets
+- [x] todo
+- [x] inline code
+- [x] code block
+- [x] strikethrough, underline, bold, italic
+- [x] nested blocks
+- [ ] embeds
+- [ ] tables
+- [ ] videos
+- [ ] convert returned markdown object to string
+- [ ] add tests
+
+## Install
+
+```Bash
+$ npm install notion-to-md
+```
+
+## Usage
+
+### converting page to markdown
+
+This is how the notion page looks for this example:
+
+![Imgur](https://imgur.com/9iqRpBl.png)
+
+```js
+const { Client } = require("@notionhq/client");
+const notion2md = require("notion2md");
+
+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:**
+
+```json
+[
+  {
+    "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": []
+  }
+]
+```
+
+### converting list of blocks to markdown
+
+> 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
+
+```js
+const { Client } = require("@notionhq/client");
+const notion2md = require("notion2md");
+
+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
+
+### Converting a single block to markdown
+
+- just takes a single notion block and returns corresponding markdown string
+- nesting is ignored
+
+```js
+const result = n2m.blockToMarkdown(block);
+console.log(result);
+```
+
+**result**:
+
+```
+![image](https://media.giphy.com/media/Ju7l5y9osyymQ/giphy.gif)
+```
+
+## API
+
+### `pageToMarkdown(page_id)`
+
+- Takes page_id as input and converts all the blocks in the page to corresponding markdown
+
+### `blockToMarkdown(block)`
+
+- 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](https://developers.notion.com/reference/block)
+
+### `blocksToMarkdown(blocks)`
+
+> **Note**: requires <u>**notion-sdk-js**</u> unlike `blockToMarkdown`
+
+- `blocks`: array of notion blocks
+- deals with <u>**nested blocks**</u>
+- uses `blockToMarkdown` internally.
+
+## Contribution
+
+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.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/notion-to-md.js

@@ -0,0 +1,98 @@
+const md = require("./utils/md");
+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;
+  }
+
+  async pageToMarkdown(id) {
+    if (!id) throw new Error("pageToMarkdown takes page_id as argument");
+    const blocks = await getBlockChildren(this.notionClient, id);
+    const parsedData = await this.blocksToMarkdown(blocks);
+    return parsedData;
+  }
+
+  /**
+   * @param {object} blocks - list of notion blocks
+   * @returns array of md blocks with their children
+   */
+  async blocksToMarkdown(blocks, mdBlocks = []) {
+    for (let i = 0; i < blocks.length; i++) {
+      let block = blocks[i];
+      if (block.has_children) {
+        let child_blocks = await getBlockChildren(this.notionClient, block.id);
+        mdBlocks.push({ parent: this.blockToMarkdown(block), children: [] });
+        let l = mdBlocks.length;
+        await this.blocksToMarkdown(child_blocks, mdBlocks[l - 1].children);
+        continue;
+      }
+      let tmp = this.blockToMarkdown(block);
+      // console.log(">>parsed data=", tmp, block);
+      mdBlocks.push({ parent: tmp, children: [] });
+    }
+    return mdBlocks;
+  }
+
+  /**
+   * @param {object} block - single notion block
+   * @returns markdown form of the passed block
+   */
+  blockToMarkdown(block) {
+    let parsedData = "",
+      blockContent;
+    const { type } = block;
+    if (type === "image") {
+      blockContent = block[type];
+      const image_type = blockContent["type"];
+
+      return md.image("image", blockContent[image_type].url);
+    } else {
+      blockContent = block[type]["text"] || [];
+      blockContent.map((content) => {
+        const annotations = content.annotations;
+        let plain_text = content.plain_text;
+
+        plain_text = this.annotatePlainText(plain_text, annotations);
+
+        if (content["href"]) plain_text = md.link(plain_text, content["href"]);
+
+        parsedData += plain_text;
+      });
+    }
+
+    // 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);
+    if (type === "heading_3") parsedData = md.heading3(parsedData);
+    if (type === "quote") parsedData = md.quote(parsedData);
+
+    if (type === "numbered_list_item" || type === "bulleted_list_item")
+      parsedData = md.bullet(parsedData);
+
+    if (type === "to_do") parsedData = md.todo(parsedData, block[type].checked);
+
+    return parsedData;
+  }
+
+  /**
+   * @param {string} text string to be annotated
+   * @param {object} annotations annotation object of a notion block
+   */
+  annotatePlainText(text, annotations) {
+    if (annotations.code) text = md.inlineCode(text);
+    if (annotations.bold) text = md.bold(text);
+    if (annotations.italic) text = md.italic(text);
+    if (annotations.strikethrough) text = md.strikethrough(text);
+    if (annotations.underline) text = md.underline(text);
+
+    return text;
+  }
+}
+
+module.exports = notion2md;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "notion-to-md",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "notion",
+    "markdown",
+    "md",
+    "notion",
+    "notion-api",
+    "notion-to-md",
+    "notion2md"
+  ],
+  "author": "",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/souvikinator/notion-to-md.git"
+  },
+  "bugs": {
+    "url": "https://github.com/souvikinator/notion-to-md/issues"
+  },
+  "homepage": "https://github.com/souvikinator/notion-to-md#readme",
+  "description": "convert notion pages, block and list of blocks to markdown (supports nesting)"
+}

package/utils/md.js

@@ -0,0 +1,57 @@
+exports.inlineCode = (text) => {
+  return `\`${text}\``;
+};
+
+exports.bold = (text) => {
+  return `**${text}**`;
+};
+
+exports.italic = (text) => {
+  return `_${text}_`;
+};
+
+exports.strikethrough = (text) => {
+  return `~~${text}~~`;
+};
+
+exports.underline = (text) => {
+  return `<u>${text}</u>`;
+};
+
+exports.link = (text, href) => {
+  return `[${text}](${href})`;
+};
+
+exports.codeBlock = (text) => {
+  return `\`\`\`${text}\`\`\``;
+};
+
+exports.heading1 = (text) => {
+  return `# ${text}`;
+};
+
+exports.heading2 = (text) => {
+  return `## ${text}`;
+};
+
+exports.heading3 = (text) => {
+  return `### ${text}`;
+};
+
+exports.quote = (text) => {
+  return `| ${text}`;
+};
+
+exports.bullet = (text) => {
+  return `- ${text}`;
+};
+
+exports.todo = (text, checked) => {
+  return checked ? `- [x] ${text}` : `- [ ] ${text}`;
+};
+
+exports.image = (alt, href) => {
+  return `![${alt}](${href})`;
+};
+
+//TODO: embed and fluid tags

package/utils/notion.js

@@ -0,0 +1,10 @@
+exports.getBlockChildren = async (notionClient, block_id) => {
+  try {
+    const response = await notionClient.blocks.children.list({
+      block_id,
+    });
+    return response.results;
+  } catch (e) {
+    console.log(e);
+  }
+};