Skip to content
forked from notree-md/notree

A web based graph view for markdown notes

License

Notifications You must be signed in to change notification settings

mpryor/mindgraph

 
 

Repository files navigation

mindgraph

A web based graph view for markdown notes - based on obsidian's graph view.

In active development and will likely have breaking changes before v1.0

Example

https://jtabb.dev/notes

Installation

pnpm add @mindgraph/read @mindgraph/draw
npm install @mindgraph/read @mindgraph/draw
yarn add @mindgraph/read @mindgraph/draw

Usage

// On the server
import { readFromFileSystem } from '@mindgraph/read';

app.get('/api/v1/notes', async (res) => {
  const notes = await readFromFileSystem('path/to/obsidian/directory');
});

// On the client
import { MindGraph } from '@mindgraph/draw';

const notes = await fetch('/api/v1/notes').then((res) => res.json());
const canvas = document.getElementById('your-canvas');

const mindGraph = new MindGraph({ data: notes, canvas });
mindGraph.draw(canvas);

Contributing

Issues and PRs are more than welcome. Please clone the repo and setup your environment with pnpm i

If you want your change to be released, run pnpm changeset before opening your PR

See each packages README for more details

About

A web based graph view for markdown notes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 86.8%
  • JavaScript 8.7%
  • HTML 4.5%