/breadcrumbs

Visualise a custom hierarchy in your Obsidian vault

Primary LanguageJavaScriptMIT LicenseMIT

Breadcrumb Trail

This plugin adds multiple new views to Obsidian.

The wiki has more in-depth info on the plugin than the readme.

You can find the changelog here.

Basics

Breadcrumbs lets you add hierarchical metadata to your notes, then leverage that structure. Using and up (↑), same (→), and down (↓) relationship, you can add directional structure to your notes.

Matrix/List view

This view shows the current note's parents, siblings, and children in either of the following styles:

image

image

To open the view in your sidebar, run the command Breadcrumbs: Open View from the command palette.

Breadcrumbs Trail view

This view shows a trail of notes from the top of your vault (See Settings#IndexNote) down to your current note

image

To get this structure, the plugin requires that you use some type of metadata indicating the hierarchy of notes. For example, you may have a yaml field called parent, which links to the current note's "parent" note: parent: [[Parent Note]]. (You can also use inline Dataview fields parent:: [[Parent Note]]). Using this structure that you impose, you can use the breadcrumb trail to visualise the path back to your parent note.

Settings

Index/Home Note

You need to supply the name of your vault's index/home note. If it is called 000 Home.md, for example, just enter 000 Home in the setting input field. If the index is nested inside folders, still just use the name of the note. Folder/Index.mdIndex, for example.

Parent Field

You also need to give the name of the field you use to indicate parent notes. For example, if you use parent: [[Note]], then enter parent into the setting field.

Sibling Field

The name of the field used to indicate notes on the same level as the current one. Related Notes: [[Note]] -> Related Notes, for example.

Child Field

The field used to show "narrower" notes, like Subtopic: [[Note]], or child:: [[Note]]

Feed my coffee problem

If you're so inclined, you can buy me a coffee over here: https://ko-fi.com/skepticmystic :)