#Noteplan plugins install#

This will install the necessary npm dependencies and initialize your plugin working directory, including: Run the following commands from the root of your local GitHub repository for NotePlan/plugins. Step 3: Initialize Local Development Environment Make sure you have a recent version of node and npm installed (if you need to install node, brew install node is the quickest method, you can follow instructions on node website). It would be good to familiarize yourself with that code. Speaking of which, there is a /helpers directory at the root of the repository that contains a lot of re-usable code that is built upon the NotePlan APIs and will speed up your development. This will give you a wealth of material to learn from and borrow from.

When you have cloned this repository, you will not only have the tooling, but you will have the actual source code for every publicly-available NotePlan plugin. You might want to consult this good modern JavaScript tutorial. If you are a developer and want to contribute and build your plugins, see the plugin writing documentation and discuss this with other developers on Discord #plugin-dev channel. If you have an idea for a plugin, submit them here or inquire in the NotePlan Discord community's #plugin-ideas channel. NotePlan Plugin API has been tested using Node.js range, any version outside of this range may lead to unexpected issues Plugin Information

macOS Catalina 10.15.2 or greater (strongly recommend macOS Big Sur 11.x or Monterey 12.x).

16 - Do Not Use Expirimental Version of Node (e.g. The following items are required for NotePlan Plugin Development Once you have read that carefully and understand the basics, you should return here to acquire and start using the NotePlan Plugin tooling described below. If you want to develop plugins, Step 1 is to read the NotePlan Knowledgebase Document describing how plugins work in NotePlan and the basic plugin anatomy.

#Noteplan plugins update#

If you are a developer and want to contribute and build your plugins, join other developers on Discord ( #plugin-dev channel).NotePlan Plugins provides an extensive API for extending default editing and task management and work across all platforms (macOS and iOS).Įach plugin command can be invoked using the NotePlan Command Bar, or by entering any of available commands directly in the editor by entering /command (NotePlan will auto update the list of possible commands as you type) If you are a user and have plugin ideas, submit them here or ask in our Discord community in the #plugins channel.

In the plugin preferences you can open the folder (if you have never installed a plugin, the folder won't be existing yet):Įach 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 modify a plugin on your Mac, you will see the changes on your iOS devices as well. Plugins are saved locally in NotePlan's database folder (CloudKit) or in your iCloud Drive folder and synced between your devices. Alternatively, you can type / anywhere in the editor to invoke a plugin command. Right after downloading (and enabling the plugin) you can close the preferences and hit ⌘J, then type / and you should see a list of available commands. On iOS, you can open the command bar (tap on the magnifier glass icon bottom right), then type “/install plugins”.

#Noteplan plugins download#

It will download and check for updates in our official repository (if you are a developer, you can submit your plugins). Or to display some details about the currently opened note, such as word, character, and line count:ĭownload or update available plugins directly in NotePlan's preferences on your Mac. 📝 Find here a list of all available plugins.įor example, the following plugin moves the currently opened note to another folder without using the mouse for drag & drop: ▶️ Watch Stacey introducing plugins here. You can download (and write) Javascript plugins to extend NotePlan's command bar with /commands to add features that are not available in the core app (works on Mac and iOS).