chrisgurney / obsidian-note-toolbar

Plugin for Obsidian providing a flexible way to create context-aware toolbars for your notes.
https://github.com/chrisgurney/obsidian-note-toolbar/wiki
Apache License 2.0
309 stars 7 forks source link
obsidian obsidian-md obsidian-plugin toolbar

Note Toolbar Obsidian Plugin

GitHub Release GitHub Release Obsidian Downloads License "Buy Me A Coffee"

The Note Toolbar plugin for Obsidian lets you create context-aware toolbars for your notes, which can include commands, links to vault files and folders, websites/URIs, and menus.

Jump to:

Demo of a sticky toolbar

More options on mobile:

Mobile options for accessing the toolbar

Features

Wondering what's new? See the Release Notes

Wondering what's ahead? See the Roadmap

Translations ๐ŸŒ

Note Toolbar is also available in:

Language name Native name What's translated Contributors
Chinese (Simplified) ็ฎ€ไฝ“ไธญๆ–‡ Plugin UI, Style Settings @Moyf
German Deutsch Plugin UI, Style Settings @hartimd
Ukrainian ะฃะบั€ะฐั—ะฝััŒะบะธะน Plugin UI, Style Settings @Laktiv

Help add more translations.

Installation

Click here or:

  1. Open Obsidian's settings, and click Community plugins
  2. Search for Note Toolbar and select it
  3. Install
  4. Make sure to Enable the plugin
Installing beta versions via BRAT
BRAT lets you beta-test plugins, to provide feedback.

As beta versions become available, I welcome your feedback and any issues you uncover!

Disclaimer: Betas are pre-release versions of the plugin. It is strongly encouraged to make a backup of your Note Toolbar's data.json file before proceeding, and/or test within a separate vault (depending on the nature of the beta).

  1. Install the BRAT plugin:
    • Open Settings > Community Plugins
    • Disable safe mode, if enabled
    • Browse, and search for "BRAT"
    • Install the latest version of Obsidian 42 - BRAT
  2. Open BRAT settings (Settings -> Obsidian 42 - BRAT)
  3. Scroll to the Beta Plugin List section
  4. Add Beta Plugin
  5. Specify this repository: chrisgurney/obsidian-note-toolbar
  6. Enable the Note Toolbar plugin (Settings > Community plugins)
  7. Restart Obsidian, or re-open your vault.
  8. In Note Toolbar's settings, confirm the version number at the top is the latest beta version.

Getting Started ๐Ÿš€

Once enabled, open Note Toolbar's settings:

  1. Create a + New toolbar
  2. Give the toolbar a name.
  3. + Add toolbar item
  4. Exit settings, and open a note.
  5. Add a notetoolbar property. Set it to the name of your toolbar.

If you want your toolbar to show without using a property, try mapping a folder (like wherever your Daily Notes are stored) to your new toolbar.

Example

Example Daily Notes toolbar including Daily Notes navigation, and multiple command shortcuts

๐Ÿ“– See the User Guide for detailed instructions, and for more examples.

Let me know how you use your toolbars!

User Guide

๐Ÿ“– See the User Guide.

Once installed and enabled, in Obsidian go to: Settings... > Note Toolbar and click + New toolbar.

Example of settings configuration

Example of settings for a toolbar

License

Note Toolbar is licensed under Apache License Version 2.0. See the LICENSE.

Inspiration and Thanks ๐Ÿ™

Shout out to other projects and people who helped me with questions I had while developing this plugin:

Contribute ๐Ÿง‘โ€๐Ÿ’ป

Happy to discuss your ideas! Pull requests are welcome!

Help add or review translations.

Support ๐Ÿ›Ÿ

๐Ÿ“– See Troubleshooting in the User Guide.

Ask questions here or request a feature. If you run into something that looks like a bug, please log an issue.

If you find this plugin useful, and wish to support me financially, I accept donations. Thank you!