mkdocs-obsidian-interactive-graph-plugin 0.2.3

A MkDocs plugin that generates a obsidian like interactive graph

Interactive Graph for Material for MkDocs

Plugin for Material for MkDocs to draw an interactive graph like Obsidian. The graph inside the sidebar is just available for non-mobile website. The modal view via the button next to the light/dark mode switch shall work on all devices.

Refer Github Pages for a demonstration of the interactive graph in Material for MkDocs.

Installation

Available on PyPI. Install via pip install mkdocs-obsidian-interactive-graph-plugin or add it to your requirements.txt.

Usage

Setup in MkDocs

Activate the plugin in mkdocs.yml, but note that this plugin has to be located before plugins, that replace wikilinks by markdown links. Currently just wikilinks like [[Link#Anchor|Custom Text]] are supported.

plugins:
  - obsidian-interactive-graph

extra_javascript:
  - https://fastly.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js
  - https://fastly.jsdelivr.net/npm/echarts@5.5.0/dist/echarts.min.js
  - assets/javascripts/graph.js

Graph Javascript by Apache ECharts

A graph.js example can be downloaded from here and must be located into the docs directory under docs/YourSiteName/assets/javascripts/graph.js.

Docker

Adapt the .env and mkdocs.yml files to your needs. DEV=ON will rebuild the mkdocs-obsidian-interactive-graph-plugin from local files. If DEV != ON the upstream packages of PyPI will be used. Build and start the Docker container via docker compose up --build [-d].

References

• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/
• https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main
• https://github.com/GooRoo/mkdocs-obsidian-bridge
• https://github.com/blueswen/mkdocs-glightbox
• https://echarts.apache.org