https://github.com/graphcentral/notion

Knowledge graph for Notion, like obsidian.md or Roam research / https://graphcentral.github.io/graph
https://github.com/graphcentral/notion

force-directed-graph graph knowledge knowledge-graph notion obsidian-md roamresearch

Last synced: 22 days ago
JSON representation

Knowledge graph for Notion, like obsidian.md or Roam research / https://graphcentral.github.io/graph

• Host: GitHub
• URL: https://github.com/graphcentral/notion
• Owner: graphcentral
• License: mit
• Created: 2022-08-07T15:30:01.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-05T03:46:21.000Z (11 months ago)
• Last Synced: 2024-10-01T09:41:43.115Z (about 1 month ago)
• Topics: force-directed-graph, graph, knowledge, knowledge-graph, notion, obsidian-md, roamresearch
• Language: TypeScript
• Homepage: https://graphcentral.github.io/graph
• Size: 3.02 MB
• Stars: 58
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# notion

![logo.png](./packages/notion-graph-scraper/logo.png)

```bash

npm i --save @graphcentral/notion-graph-scraper

```

You will be able to visualize the output from @graphcentral/notion-graph-scraper with [@graphcentral/graph](https://github.com/graphcentral/graph) like below:

![doc1.png](./packages/notion-graph-scraper/doc1.png)

## Example

First, get a public Notion page (if you just want to test it out), preferably with some sub-pages inside it, so that you can get a graph with some nodes. You can also request private pages if you create your own instance of `NotionAPI` from `notion-client`. The example below is only for public pages.

Then, get the id of the page like below:

![doc0.png](./packages/notion-graph-scraper/doc0.png)

Then, input the id of the page as a parameter to `notionGraph.buildGraphFromRootNode`

```ts

import { NotionGraph } from "@graphcentral/notion-graph-scraper"

import fs from "fs"

/**

 * example of how to use `@graphcentral/notion-graph-scraper`

 */

;(async () => {

  const notionGraph = new NotionGraph({

    maxDiscoverableNodes: 2000,

    maxDiscoverableNodesInOtherSpaces: 2000,

    verbose: true,

  })

  const graph = await notionGraph.buildGraphFromRootNode(

    // Some random Japanese blog

    `95fcfe03257541c5aaa21dd43bdbc381`

  )

  console.log(graph.nodes.length)

  console.log(graph.links.length)

  await new Promise((resolve, reject) => {

    fs.writeFile(`test0.json`, JSON.stringify(graph), (err) => {

      if (err) reject(err)

      else resolve(``)

    })

  });

  process.exit(0)

})()

```

The graph will be an object of this type:

```ts

{

  nodes: Node[]

  links: Link[]

  errors: Error[]

}

```

Then, you can directly use this as an input to [@graphcentral/graph](https://github.com/graphcentral/graph) to visualize it on the web as a force layout graph.

## Example setup

An example setup is at [@graphcentral/notion-scrape-example](https://github.com/graphcentral/notion-scrape-example).

## Use ES6 module instead of Commonjs

This project uses es6 module (.mjs). Therefore, the following setup is needed:

In your `package.json`, specify "type" as "module"

```json

{

  ...

  "type": "module",

  ...

}

```

Then, using the latest version of node (this project uses whatever is specified in `.nvmrc` which is as of now `v16.15.1`), just run `node index.js` where `index.js` contains the previous example code.