Skip to content

MetaCorp/Cross-reference-Navigation-for-Obsidian

 
 

Repository files navigation

Cross-reference Navigation plugin for Obsidian

This is a plugin for Obsidian that lets you navigate through your notes using their tags.

It's a live demonstration of a concept laid out in my lab notes.

For more information, see my page on this experiment, or read below.

Demo

This plugin surfaces commonly cross-referenced tags as you browse through your things, and it makes great use of nested tags (e.g. #status/inprogress).

Here's a video showing it in action »

With the tag structure I use in my personal notes vault, this plugin effectively gives me a handful of useful interfaces. Some examples:

  • "In Progress" shows me my current workspace: all of the things I'm learning and working on right now.
  • "Up Next" is filled with new and interesting things to explore.
  • "Done" is a nicely organized archive.
  • "Reading" brings up things I've read, things I'm in the middle of, and what I'd like to read next.
  • "Writing" brings up the things I've written recently, am currently writing, and might work on next.

And of course, I can dive deeper from there: I might pull up just the things I'm reading in the topic of music, or specifically the things I'm currently writing on personal computing, or the things I'd like to read next by Doug Engelbart.

Testing

If you want to try out this plugin, be aware: It is early, so I'd recommend using it with a sample vault, such as the one I've published. It may be slow in vaults with many notes and tags, and there will be bugs!

Here's how to try it out:

  1. If you don't have it yet, download and install Obsidian.
  2. Download the plugin (v0.3.0), and unzip it.
  3. Move the unzipped directory into your vault's .obsidian/plugins directory.
  4. In Obsidian's settings window, open "Community plugins," hit the refresh button on "Installed plugins," and enable "Cross-reference Navigation."
  5. Open the command palette (press CMD + P), and search for the command "Cross-reference Navigation: Open Cross-references View". Press enter when it's highlighted.

If you want to use it with a sample vault, I've published the one from the demo video, and it already has the plugin installed.

  1. If you don't have it yet, download and install Obsidian.
  2. Download the sample vault, and unzip it.
  3. Open Obsidian, click the vault icon in the bottom left of Obsidian's window ("Open another vault"), then select the unzipped sample vault directory.
  4. Click "Turn off safe mode" if asked, and close the settings window if it's open.
  5. Open the command palette (press CMD + P), and search for the command "Cross-reference Navigation: Open Cross-references View". Press enter when it's highlighted.

If you enjoy this experiment, you can see the rest of my work at https://alexanderobenauer.com/.


Credits & Acknowledgements

The concept is based on my lab note on Cross-references & References cloud.

This plugin's codebase was originally based on Obsidian Calendar Plugin.

About

Cross-reference navigation through your Obsidian tags and notes

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 59.8%
  • Svelte 36.0%
  • JavaScript 4.2%