"alias" = (Note: available from v.3.0.26, backward compatible) Optional string array of alternative keywords when searching for the plugin."name" = Name of the "/command" (don't include the "/" here) which will be available to the user.You can have multiple commands per plugin. NotePlan will call this function when the user executes the /command. Each command refers to a function in the plugin.script file.
NotePlan will load this list and make it available in the Command Bar as auto-complete options.
Noteplan plugins download#
They have to be in the same folder as the plugin.json (which means you need to download and add them to the folder).
In pendencies you can add the file names of third-party Javascript libraries.Use semantic versioning and avoid using anything other than numbers and periods, like "1.4.1". NotePlan will read this field and compare it to the local version. plugin.version is important when the plugin is available as release on the repo.plugin.name, thor, plugin.url (website of your plugin), and scription will be used in the plugin preferences in NotePlan to describe the released versions.If the plugin is downloaded through NotePlan's preferences, it will use the plugin.id to create and name the folder automatically. If you plan to submit your plugin (please do!), we need to keep the IDs unique across the repository, so that NotePlan can load them properly. plugin.id should be unique and identical to the folder which is containing the plugin files.But this is less critical as most phones are updated quickly, while relatively many Macs are not updated due to old hardware. Version 14 supports all plugins, lower versions might not anymore. iOS.minVersion Similar to the macOS minVersion, but for iOS.Note: In NotePlan 3.0.23 it still defaults to macOS 11 (Big Sur).Use a transpiler to support older JS versions and set the macOS.minVersion to "10.13" if you are using async/await, otherwise use "10.12" as the minimum version. The minimum version supported by NotePlan is 10.12 (Sierra), but this doesn't support async/await. Older macOS versions have outdated Javascript engines so that new JS syntax is not supported. macOS.minVersion This defaults to macOS 10.15.7 (latest Catalina version) if you don't define it.Version numbers will be documented in the API, when a change is made. The plugin API is constantly extended, so older versions might not have the API features you are using. noteplan.minAppVersion Set the minimum NotePlan version number this plugin works on."description": "Moves note to another folder", "scription": "Move a note from the current folder into another.", "plugin.name": "Move selected note to another folder",
Here is an example of a minimal plugin.json file: The easiest way to find the folder is to open it from the plugin preferences by clicking on "Open Plugin Folder". other supporting files, like other Javascript dependencies.script.js // the script file containing the code).Plugin-name // one folder per plugin, the name is expected to the plugin.id below.Here is an example of the folder structure: NotePlan will call specific functions in this call, depending on which command was executed.Īll plugin files have to be inside NotePlan's database folder. and it defines which commands will be available in NotePlan's Command Bar. The plugin.json file contains the meta-information about the plugin like id, author, name, etc. Plugin SetupĪ plugin is made up of at least two files: plugin.json and script.js (the name is defined in the plugin.json).
Noteplan plugins how to#
This article walks you through how to start creating a plugin. Find example of other plugins in the same repo. You can write custom Javascript plugins and share them with the community by submitting a pull request to our official GitHub repo. More Complex / Efficient Plugin Development.