See the wiki for in-depth documentation.
Join our discussions in GitHub or Discord.
Breadcrumbs lets you add hierarchical structure to your notes and then leverage that structure.
The core of Breadcrumbs are the 5 directions:
- up (↑)
- same (↔)
- previous (←)
- next (→)
- down (↓)
You can name these whatever you want. For example, you can use parent, sibling, child, left, right. What matters is the direction behind them.
To get this structure, the plugin requires that you use some type of metadata indicating the hierarchy of notes:
- Frontmatter field. This is a field in the yaml format at the very top of your note. For example the
me.mdfile could have the following frontmatter:
---
parent: [[dad]]
parent: [[mom]]
sibling: [[sister Lara]]
child: [[child Andre]]
---
- Inline (must use the Dataview plugin), among the normal text like this:
Punching is a very effective MMA technique (sibling:: [ [[Kicking]], [[Elbowing]], [[Kneeing]] ], parent:: [[Striking]])
(notice the double colon for the Dataview inline metadata).
- You can combine both approaches as well. For example your
Course. 101 - Basics of Financing.mdfile might have the following content:
---
up: [[Year 2022 courses]]
same: [[Course. 103 - Basics of Programming]]
---
# Course. 101 - Basics of Financing
This course teaches the basics of financing. It contains several sub-areas:
- down:: [[101 - Basics of Financing. Lectures]]
- down:: [[101 - Basics of Financing. Group work]]
- down:: [[101 - Basics of Financing. Essay]]
Next:: [[Course. 201 - Advanced Financing]]
This view shows the current note's parents, siblings, and children in either of the following styles:
To open the view in your sidebar, run the command Breadcrumbs: Open View from the Command Palette (Ctrl+P).
This view shows a trail of notes from the top of your vault down to your current note:
Using this structure that you impose, you can use the breadcrumb trail to visualise the path back to your parent note.
The Juggl plugin is tightly integrated with Breadcrumbs, such as with the Juggl view that can automatically be added above your current note:
http://youtube.com/watch?v=AS5Mv6YNmsQ
If you're so inclined, you can buy me a coffee over here: https://ko-fi.com/skepticmystic :)
- Push all previous changes to the actual project
- Bump version in
package.json npm run version:betato updatemanifest-beta.jsonandversions.jsonaccordinglygit tag -a x.x.x-beta -m 'x.x.x-beta'to tag the buildgit push origin x.x.x-betato push the release and trigger the action