1 minute read

Obsidian Notes Linker is a new open-source project designed to help users of Obsidian, a popular markdown-based note-taking app, to automatically link their markdown files. This tool is written in Python and is available on GitHub for anyone to use and contribute to.

Project can be found on Github Obsidian Linker

Features

  • Automatic Linking: The tool scans your markdown files and automatically creates links between notes based on their content.
  • Efficient: Handles large collections of notes quickly and efficiently.
  • Uses Wikilink Format: Links are created using the Wikilink format, which is compatible with Obsidian.
  • Skip Links in Metadata: The tool intelligently skips linking within metadata sections of your notes.
  • Skip Links in Codeblocks and Inline Code: Ensures that links are not created within code blocks or inline code, preserving the integrity of your code snippets.

Installation

To install the Obsidian Notes Linker, you can clone the repository from GitHub and install the required dependencies:

git clone https://github.com/arshad115/obsidian-linker.git
cd obsidian-linker
pip install -r requirements.txt

Usage

To use the tool, simply run the following command in your terminal:

python obsidianlinker.py /path/to/vault/

Usage

This will scan your notes and add links where appropriate.

Example

I ran the obsidian linker on my digital garden with 430 markdown notes and it added 17,191 links. I had not linked notes except for the ones in one folder and it did an amazing job of making the graph travel easy and it just looks beautiful!

Before Linking

Before Linking

After Linking

After Linking

Warning: Make sure to back up your vault before using this tool, as it can make irreversible edits.

Contributing

Contributions are welcome! If you have any ideas for new features or improvements, feel free to open an issue or submit a pull request on Obsidian Linker GitHub.

Conclusion

Obsidian Notes Linker is a powerful tool for anyone looking to enhance their note-taking experience in Obsidian. By automating the process of linking notes, it saves time and helps you create a more interconnected and useful knowledge base. Check out the project on GitHub and start linking your notes today!

Leave a comment