/semantic-markdown-converter

Neo4j Graph View is a more functional graph view to Obsidian. It connects to a Neo4j database, allowing useful querying and visualization options.

Primary LanguageTypeScriptMIT LicenseMIT

Neo4j Graph View

Documentation at https://publish.obsidian.md/semantic-obsidian/Neo4j+Graph+View+Plugin. Join the new Discord server to discuss the plugin: https://discord.gg/sAmSGpaPgM

Adds a new and much more functional graph view to Obsidian. It does so by connecting to a Neo4j database. Features:

  • Selectively style nodes and edges by tags, folders and link types
  • Selective expansion and hiding of nodes
  • View images within the graph
  • Cypher querying
  • Typed links using - linkType [[note 1]], [[note 2|alias]]
  • Hierarchical layout

Installation

Detailed installation instructions is at https://publish.obsidian.md/semantic-obsidian/Installation+of+Neo4j+Graph+View+Plugin

  1. Make sure you have Python 3.6+ installed. It needs the system-installed Python. Make sure to add Python to PATH!
  2. Make sure you have Neo4j desktop installed
  3. Create a new database in Neo4j desktop and start it. Record the password you use!
  4. In the settings of the plugin, enter the password. Then run the restart command.

If installing Python seems daunting, you can wait a couple of weeks. The goal is to port that code to Javascript.

Use

Detailed getting started guide is at https://publish.obsidian.md/semantic-obsidian/Using+the+Neo4j+Graph+View

On an open note, use the command "Neo4j Graph View: Open local graph of note". You can run commands using ctrl/cmd+p. Alternatively, you can bind this command to a hotkey in the settings.

The settings contains several options, such as coloring based on folders and a hierarchical layout.

Cypher Querying

Create code blocks with language cypher. In this code block, create your Cypher query. Then, when the cursor is on this code block, use the Obsidian command 'Neo4j Graph View: Execute Cypher query'. Example:

Possible problems

All changes made in obsidian should be automatically reflected in Neo4j, but this is still very buggy.

If you are running into issues, see https://publish.obsidian.md/semantic-obsidian/Installation+of+Neo4j+Graph+View+Plugin#troubleshooting

Semantics

The plugin collects all notes with extension .md in the input directory (default: markdown/). Each note is interpreted as follows:

  • Interprets tags as entity types
  • Interprets YAML frontmatter as entity properties
  • Interprets wikilinks as links with type inline, and adds content
  • Lines of the format "- linkType [[note 1]], [[note 2|alias]]" creates links with type linkType from the current note to note 1 and note 2.
  • The name of the note is stored in the property name
  • The content of the note (everything except YAML frontmatter and typed links) is stored in the property content
  • Links to notes that do not exist yet are created without any types.

Other visualization and querying options

Another use case for this plugin is to use your Obsidian vault in one of the many apps in the Neo4j desktop Graph Apps Store. Using with this plugin active will automatically connect it to your vault. Here are some suggestions:

Neo4j Bloom

Neo4j bloom is very powerful graph visualization software. Compared to the embedded graph view in Obsidian, it offers much more freedom in customization.

GraphXR

GraphXR is a 3D graph view, which looks quite gorgeous!

Neo4j Browser

A query browser that uses the Cypher language to query your vault. Can be used for advanced queries or data anlysis of your vault.

Python code: Semantic Markdown to Neo4j

This Obsidian plugin uses the Python package semantic-markdown-converter, which is also in this repo. It creates an active data stream from a folder of Markdown notes to a Neo4j database. For documentation, see https://publish.obsidian.md/semantic-obsidian/Semantic+Markdown+Converter