Skip to content

README.md

Latest commit

 

History

History
46 lines (27 loc) · 2.44 KB

README.md

File metadata and controls

46 lines (27 loc) · 2.44 KB
Raw

Obsidian-Vault-HTML-Graph-Generator

Important Information

Current Limitations: At present, the graph only supports Obsidian's graph view #tag filters and colors. Any other filters set in Obsidian's graph view will be ignored. This tool only generates the graph view; note contents will not be accessible from the graph.

Overview

The Obsidian-Vault-HTML-Graph-Generator is a tool designed to transform your Obsidian vault into an interactive HTML graph view, making it easier to share and visualize your notes and connections in a web browser. This tool is ideal for both tech-savvy users and those who prefer a simple, executable solution.

Features

  • Interactive HTML Graph: Generates a visual representation of your Obsidian notes and their links.
  • User-Friendly Interface: Simple GUI for selecting the vault and output directories.
  • Compatibility: Supports Obsidian's graph view #tag filters and colors.
  • Portability: Easily share the generated HTML file with anyone.

Usage

For Non-Tech Savvy Users

Note: The antivirus will throw a check for the executable file, I don't have any way of avoiding this AND making it easier for non tech savvy people. Sorry.

  1. Download and Run: Download the provided executable file and run it. Follow the on-screen instructions to select your Obsidian vault and output directory.

For Python Users

  1. Download the Script: Clone the repository to get the Obsidian-Vault-HTML-Graph-Generator.py file.

  2. Run the Script: Execute the script using Python. Make sure you have the necessary Python dependencies installed (e.g., tkinter, markdown, json, re, defaultdict).

    python Obsidian-Vault-HTML-Graph-Generator.py

Contribution

We welcome contributions from the community. Feel free to submit pull requests or report issues to help improve this project.

Support

If you find this tool useful and would like to support its development, consider supporting the project here.

Notes

  • Code Quality: "Yes, it's messy. Yes, it's only one file, but I was in a hurry. There's a better way to structure this, but who cares, right?"
  • Future Plans: Currently, there are no plans to make this an Obsidian plugin, I'm pretty sure something like this has been already developed as a plugin.