Skip to content

SkepticMystic/breadcrumbs

Repository files navigation

Important

Breadcrumbs has recently been rewritten from scratch, and is available in the V4 beta (downloadable via the Obsidian BRAT plugin). See here for more info on the changes: https://github.com/SkepticMystic/breadcrumbs/blob/master/V4.md

Breadcrumbs is an Obsidian plugin that lets you add typed links to your notes, then view/traverse them in various ways. Internally, Breadcrumbs uses a graph to represent this structure (much like the regular Obsidian graph, except now, links have types to them). You tell Breadcrumbs about the structure of your notes, then it lets you visualise and navigate the graph.

Documentation

Breadcrumbs now has its own Obsidian Publish docs site!✨ Going forward, that's where you can find all detailed documentation on the plugin. Check it out here: https://publish.obsidian.md/breadcrumbs-docs

Media

Media related to Breacrumbs. Thanks to everyone for sharing!

Videos

Written

Credits

  • mProjectsCode: For their PRs, insightful suggestions, and efficiency improvements.
  • HEmile: For their PRs, and helpful discussions on graph-theory.

Donations

If you like Breadcrumbs and want to show your support, there are a few ways you can do so:

  • Make a donation to your local animal shelter or charity. To support the animals in my country, you can donate to the SPCA. If you do, please let me know! I'd love to hear about it :)
  • I have a coffee problem, which you can indulge here: https://ko-fi.com/skepticmystic

Contributing

Release process

Prod

TODO

Beta

  1. Push all previous changes to the actual project
  2. Bump version in package.json
  3. npm run version:beta to update manifest-beta.json and versions.json accordingly
  4. git tag -a x.x.x-beta -m 'x.x.x-beta' to tag the build
  5. git push origin x.x.x-beta to push the release and trigger the action

Or, do steps 3-5 in one go with npm run release:beta