Skip to content

cipherswami/joplin-plugin-quick-note

Repository files navigation

Quick Note

Quick Note is a Joplin plugin that lets you instantly open a dedicated note either automatically on startup or anytime via a keyboard shortcut.

Features

  • 🚀 Automatically open Quick Note on Joplin startup (can be disabled)
  • 📝 Set any existing note as your Quick Note
  • ⌨️ Open Quick Note anytime with Alt + Q (customizable)
  • 🔄 Easily unset or change the Quick Note

Installation

  1. From Market-Place (Recommended)
  • Open Joplin and navigate to Tools → Options → Plugins → Search
  • Search for Quick Note
  • Click Install and restart Joplin
  1. From Source
  • Build the plugin package file (.jpl):

    git clone https://github.com/cipherswami/joplin-plugin-quick-note.git
    cd joplin-plugin-quick-note
    npm install
    npm run dist
  • Then in Joplin, Go to Tools → Options → Plugins → Install from file

  • Select the generated .jpl file from the publish/ directory

Usage

Set a Quick Note:

  • Open a note and go to Tools → Quick Note → Set as Quick Note, OR
  • Paste the Note ID in Tools → Options → Quick Note → Quick NoteID, OR
  • Open desired note and run the Set as Quick Note command

Access Quick Note:

  • Press Alt + Q (customizable shortcut), OR
  • Click the Quick Note toolbar button, OR
  • Go to Tools → Quick Note → Open Quick Note, OR
  • Run the Open Quick Note command

Note: Plugin automatically opens quick note on startup (Can be turned off in settings)

Remove Quick Note:

  • Go to Tools → Quick Note → Unset Quick Note, OR
  • Run the Unset Quick Note command

Settings

Access settings at Tools → Options → Quick Note:

  • Open on Startup - Automatically open Quick Note when Joplin launches
  • Quick Note ID - The NoteID of your designated Quick Note

Support

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contributions are welcome! Visit the GitHub repository to submit pull requests or suggest new features.

About

Joplin plugin to quickly jot down notes on startup or with a shortcut.

Topics

Resources

License

Stars

Watchers

Forks