ulauncher-dendron

Access your Dendron notes from Ulauncher.

Features

Integrates with Dendron, by reading .dendron.cache.json file, located in your Vault(s) folder.
Find your notes by their title or hierarchy path.
Multi-vault support.
Compatible with multiple ways to launch Dendron (VSCode, Codium, separate extensions dir, etc). Just specify the full command to open your Dendron workspace on the Extension settings.
Open file with Quickmd for quick preview. Requires quickmd to be installed.

Demo

System Requirements

Ulauncher > 5.0
Dendron with Caching enabled (default).
Python >= 3

Install

Open ulauncher preferences window -> extensions -> add extension and paste the following url:

https://github.com/brpaz/ulauncher-dendron

Usage

By default this extension looks for dendron keyword. You can change it to something shorter like dd on the extension settings.
Typing the keyword and then a query, it will filter all your notes matching that query in both title and hierarchy fields.

Before starting using this extension, you must set some settings to match your Dendron install. See section below.

🚨 Dendron cache files are only updated on the initialization of the Dendron Workspace. This means new notes won´t appear unless you reload your Dendron workspace.

Open with quickmd

Select an item and press ALT-Enter

Configuration

This extension requires the following settings to be set, according your Dendron install:

Name	Description	Example
Dendron Workspace	The absolute path to the Dendron workspace root directory on your system.	`/home/bruno/Dendron`
Dendron Vaults	A Comma separated list of Dendron vaults to be indexed, relative to the Dendron Workspace root.	`vault.personal,vault.dev`
Dendron Command	The command to open your Dendron Workspace. Use `%f%` to indicate where the file path of the selected file will be placed.	`/usr/bin/codium --user-data-dir=/home/bruno/.config/dendron/data --extensions-dir=/home/bruno/.config/dendron/ext /home/bruno/Dendron/dendron.code-workspace %f%`

Other commands

Notes are cached at Uluancher startup. To Refresh the notes cache at any time, run dendron :reload.

Development

git clone https://github.com/brpaz/ulauncher-dendron
make link

The make link command will symlink the cloned repo into the appropriate location on the ulauncher extensions folder.

To see your changes, stop ulauncher and run it from the command line with: make dev and follow the instructions.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

💛 Support the project

If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.

The sinplest form of support is to give a ⭐️ to this repo.

You can also contribute with GitHub Sponsors.

Or if you prefer a one time donation to the project, you can simple:

brpaz / ulauncher-dendron