Code Monkey home page Code Monkey logo

obsidian-journey-plugin's Introduction

Obsidian Journey Plugin - Discover the story between your notes!

GitHub release) GitHub all releases

Hey there and welcome!

Alexis here - Obsidian enthusiast and student at the University of Life!

I want to show you a new Obsidian plugin I've been working on.

This plugin automatically creates an outline for your publishing.

An outline for an article, a blog post, or even a book!

Why do we need this?

I’ve noticed that my creative output using Obsidian hasn't been as prolific as I’d like it to be.

I have hundreds of atomic notes in my vault, I’ve followed every best-practice, but right now, Obsidian didn’t help me take that next step.

It’s really hard to extract a good story from my vault.

This plugin automatically finds and creates the outline of my story like so:

What the plugin finds for you

Tutorial

Watch on Youtube: https://youtu.be/6k2Lp1pCZpY

Included Features

Based on the amazing community feedback and comments, I realized that there are many different ways to go on that journey and so I've created a bunch of features you can toggle on or of to your liking.

These features are like preferences you can give your navigation-system in your car. Maybe today, all you care about is getting from A to B quickly. Maybe tomorrow, you have more time to "take the scenic route." I want you to be as flexible as possible.

✔ Path-Finding Features

➡️ Use "Forward-Links" (Enabled by default)

If set, allows to travel using forward-links. If you have a graph like this: A -> B -> C and you ask about the story between A and C, it will give you 'A, B, C' since A forward-links to B and B forward-links to C

⬅️ Use "Back-Links" (Enabled by default)

If set, allows to travel using back-links. If you have a graph like this: A -> B -> C and you ask about the story between C and A, it will give you 'C, B, A' since C has a back-link from B and B has a back-link from A

✔ Include Tags Feature

🏷 Use tags (Disabled by default)

If set, allows to travel using tags.

✔ Avoid Traveling via Certain Notes Features

🏞 "Take the scenic route" (Disabled by default)

If set, will skip 'hub' notes with too many links (MOCs). Configure exactly how many links make a MOC below.

⚙️ "How many links make a MOC?"

Configure at which point to skip a note because it contains too many out-bound links. Applies only if 'Take the scenic route' above is set.

🙅🏻‍♀️Exclude specific folders (Disabled by default)

If set, will note include notes from the specified folders in your search. Please use comma to deliminate several folders

✔ Clipboard Settings Feature

🔗 Enable automatic linking (Disabled by default)

If set, will turn titles in the list into links to their respective note

🤪 Enable automatic transclusion (Disabled by default)

If set, will automatically create transcluding links for you ('![[note]]' instead of '- [[note]]')

✔ Accessibility Feature

🔎 Enable High-Contrast

If set, will increase the contrast to make the result-list easier to read.

Join the Discussion!

Share your ideas and feedback on the plugin. We regularly vote on which features should be built next

https://forum.obsidian.md/t/new-plugin-journey-find-the-story-between-your-notes/12153

A huge shout-out to thoresson, alltagsverstand, Thecookiemomma, cestvrai, matteor, Danashafir, EhuddRomero, I-d-as, osgav, Erick_James_Dodge, 3mbry0, Klaas, ryanjamurphy, EdElgar and Daveb08 for helping making this awesome for everyone!

How to submit an issue

🐞 If you run into a TECHNICAL ISSUE or BUG: Please submit a Github Issues at https://github.com/akaalias/obsidian-journey-plugin/issues

See what features are coming up

https://trello.com/b/ICKWjoBu/obsidian-journey-plugin-backlog

Trello

Path-Finding Feature Deep Dive

Because each feature has an impact to whether the plugin CAN FIND or CANNOT FIND a path between your two notes, I want to demonstrate what each does as simply as possible.

So, let's start by imagining this very basic vault with 4 notes. "Note A", "Note B", "Note C" and "Note D"

  • A links to B
  • B links to C
  • C shares the same tag as D

Vault

Feature 1: Use "Forward-Links" (Enabled by default)

Links are basically one-way streets from one note to the next. That means the plugin will show you only a path IF a forward-linked path exists but it won't show you a path that goes "against" the one-way street.

forwardlink

With the example and this feature turned ON, the plugin will...

  • Successfully find you a path from A to C (Via B)
  • NOT find you a path from C to A because that would be against the one-way street

Feature 2: Use "Back-Links" (Enabled by default)

This is basically the inverse of using "forward-links". With this feature, you navigation system will find ONLY paths that are based on going against the one-way streets.

backlink

With the example and this feature turned ON, the plugin will...

  • NOT find a path from A to C because there are no back-links to follow
  • Successfully find you the path from C to A (Via B) because the back-links point that direction

Feature 3: Using Tags (Disabled by default)

Thank you alltagsverstand for the idea which I had not thought of and which resonated with many of you.

As the name suggests, Tags can now also be paths between notes.

tag

With the example and this feature turned ON, the plugin will...

  • Successfully find the path from C to D (C -> #tag -> D) and from D to C (D -> #tag -> C)

If I now have Back-Links and Forward-Links enabled as well, I can now find the path from:

  • A to D (A -> B -> C -> #tag -> D)
  • D to A (D -> #tag -> C -> B -> A)

Note that this feature is disabled by default.

Feature 4: "Take the scenic route" aka Avoid MOCs (Disabled by default)

One of thoresson's many ideas that turned out to be really, really useful when I started to pressure-test finding cool paths.

Avoid Y (perhaps a tag used for MOC and other structured notes so that only atomic notes are included in the journey)

If turned on, this feature will exclude finding a path via MOC notes and help you "take the scenic route" instead. With this feature, you avoid passing through the "big city" (aka MOC) and instead find a path less traveled.

In the following example, with this feature turned ON, the path from A to C would be:

  • A -> Foo -> Bar -> C (instead of A -> MOC -> C)

MOC

"How many links make an MOC?"

A sub-feature for "taking the scenic route" where you can define at what amount of links inside a note makes it an MOC to avoid.

The original launch demo

Watch on Youtube: https://youtu.be/iRydNlinRlc

obsidian-journey-plugin's People

Contributors

akaalias avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

obsidian-journey-plugin's Issues

Icon

Thanks for the great plugin. Probably this is already know, but the icon keeps dark also in lightmode. Furthermore, the icon in darkmode is brighter than the others:

Bildschirmfoto 2021-02-08 um 14 28 19
Bildschirmfoto 2021-02-08 um 14 28 23

mutated vowel/umlaut-tag problems

The Journey Between Note-Count-Folder/Sonstiges/BIBLIOGRAPHIE/Keller, Gottfried - Gesammelte Briefe 3.1.md and 0204j Biedermeier.md

  • Note-Count-Folder/Sonstiges/BIBLIOGRAPHIE/Keller, Gottfried - Gesammelte Briefe 3.1
  • Note-Count-Folder/:brain: Brain/0003 Buchstabengarten
  • Note-Count-Folder/:brain: Brain/0001 Bücher
  • #B <–THIS!!
  • 0204l Vormärz
  • 0204j Biedermeier

The tool doesn't recognise a word as a whole tag, if there is a umlaut in it.
E.g.: #Bücher -> #B

Greetings, Leo

Journey not found when one is present

When trying to find a journey between two notes, one isn't found when it can be seen to exist on the graph:

image

Tags, forward and backlinks are all enabled, taking the scenic route is disabled (so it’s not blocking along the path anywhere). Test vault with no other plugins active and just those six notes shows the same issue (vault sent to you privately).

Obsidian 0.10.12 installer version 0.9.17
v0.0.4 of the plugin
MacOS 11

"Find Journey" command

I have completely hidden the sidebar in my theme, so I can't use this plugin unless I re-enable the sidebar icon.

A solution would be adding a command to open the plugin dialog.

And if this is implemented, I think an option to enable/disable the ribbon icon would be handy! 😄

Search method does not suit my language

Issue:
I am a chinese user and most of my notes title are in chinese. This brings me problems.

Currently, the "starting notes title" and "ending notes title" search bars would show lists of notes path only when I enter 4 or more characters. But in chinese, titles can easily be less than 4 characters, sometimes even 1. This cause me trouble in using the plugin. I am missing many notes and I need to copy the path of a note to fix this. It is really a bad experience.

Request
How can I change the search method so that notes lists appear when I enter 1 or more character? May be I can change some variable in the code? I dont know how to read JS so I couldn't figure it out myself. PLS HELP

Journey searching endlessly

When I pick two notes, no matter where they are located in my vault, no matter if they are connected, the "Searching..."-window will stay for hours showing no result until I close it manually.
I tried deactivating all other plugins, restarting, reinstalling ... nothing changed.

Details:

  • Vault size: ~2000 Notes, some not connected or empty
  • Windows 10, very strong PC
  • Obsidian Sync = enabled
  • Obsidian Publish = enabled
  • Files are stored locally, not in a cloud.
  • Automatic Updates = enabled

If I forgot something, just ask.
Have a good time!
Leo

Failed to load plugin obsidian-journey-plugin

Hi,

I´m trying to install the plugin in my obsidian vault but this error keeps showing up ("Failed to load plugin obsidian-journey-plugin"). I have put the obsidian-journey-plugin file inside ".obsidian\plugins" but it´s not working, don´t know what is the problem

Btw, Love your plugin

Peace,

Stefan

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.