

Configuring babel babel (a JS compiler).Configuring flow flow (for type checking).Configuring eslint eslint (for checking code conventions).
#Noteplan url scheme install#
This will install the necessary npm dependencies and initialize your plugin working directory, including: Run the following 3 commands from the root of your local GitHub repository for NotePlan/plugins.

Step 3: Initialize Local Development Environment Make sure you have the proper version of node installed (if you need to install node, brew install is the quickest method, or you can follow instructions on node website). There is a searchable index of the helper code that can be accessed by running this command in a terminal: It would be good to familiarize yourself with that code by browsing it. Speaking of which, there is a /helpers directory at the root of the repository that contains a lot of useful functions 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.
#Noteplan url scheme how to#
Read these instructions for how to fork and clone this code

Step 1: Forking/Cloning NotePlan Plugin Repository 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 channel. This way you can flip in and out of Node versions at will. The fast/easy way to do that is with a Node version manager like "n". If you are developing elsewhere using Node v17+, you will want to switch to Node v16 when you are doing NotePlan Plugin development. The NotePlan plugin code has not yet been migrated to Node versions >16. github CLI gh is strongly recommended - how to install gh.macOS Catalina 10.15.2 or greater (strongly recommend macOS Big Sur 11.x or Monterey 12.x).Node 14 or 16 - Do Not Use any Node version 16 (see "Switching Node Versions").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 url scheme update#
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 / (NotePlan will auto update the list of possible commands as you type)
