Plugins
You can install or create JavaScript plugins to add new features to NotePlan. These plugins can add "/commands" to the command bar or open an HTML-based interface in a separate window. They work on both Mac and iOS.
π Browse, search and install Plugins
βΆοΈ Watch Stacey introducing plugins here.
Examples
π Note Helpers β /move note
Move the currently opened note to another folder without using the mouse for drag & drop
π’ Note Statistics β /wc
Display some details about the currently opened note, such as word, character, and line count:
Install Plugins
Install plugins directly in NotePlan's preferences on your Mac or visit our Plugin Page. It will download and check for updates in our official repository (if you are a developer, you can submit your plugins here).
On iOS, you can open the command bar (tap on the magnifier glass icon bottom right), then type β/install pluginsβ.
Right after downloading you can close the preferences and hit βJ
, then type /
and you should see a list of available commands.
Alternatively, you can type /
anywhere in the editor to invoke a plugin command. If you want to see all commands in a list along with their plugins, you can use the plugin "Plugin Information & Tester" to generate a listing.
Where are plugins saved?
Plugins are saved locally NotePlan's folder and synced between your devices. In the plugin preferences you can open the folder (if you have never installed a plugin, the folder won't be existing yet):
Each plugin is saved into a separate folder having at least one setup file plugin.json
and one script file which is defined in the setup file (for example script.js
):
If you are a user and have plugin ideas, submit them here or ask in our Discord community in the #plugins
channel.
If you are a developer and want to contribute and build your plugins, join other developers on Discord (#plugin-dev
channel).
Next up: Create Command Bar plugins β
Jump to:
- Plugins (you're here)
- Create Plugins
- Javascript Plugin API
- Plugin Hooks
- Releasing a plugin