| Or get the Portable version
| You can also use Homebrew (unsupported): `brew cask install joplin`
-Linux | 
| An Arch Linux package (unsupported) [is also available](#terminal-application). | Or get the Portable version | You can also use Homebrew (unsupported): `brew cask install joplin`
+Linux | | An Arch Linux package (unsupported) [is also available](#terminal-application).To get started with the plugin API, check the Get Started page or have a look at the TOC tutorial.
-Once you are familiar with the API, you can have a look at the plugin API reference for a detailed documentation about each supported feature.
+Once you are familiar with the API, you can have a look at the plugin API reference for a detailed documentation about each supported feature.
Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.
- +View the renderer demo plugin + View the editor demo plugin
Registers a new CodeMirror plugin, which should follow the template below.
+module.exports = { + default: function(context) { + return { + plugin: function(CodeMirror) { + // ... + }, + codeMirrorResources: [], + codeMirrorOptions: { + // ... + }, + assets: { + // ... + }, + } + } +}+
+The
+contextargument is currently unused but could be used later on to provide access to your own plugin so that the content script and plugin can communicate.The
+pluginkey is your CodeMirror plugin. This is where you can register new commands with CodeMirror or interact with the CodeMirror instance as needed.The
+codeMirrorResourceskey is an array of CodeMirror resources that will be loaded and attached to the CodeMirror module. These are made up of addons, keymaps, and modes. For example, for a plugin that want's to enable clojure highlighting in code blocks.codeMirrorResourceswould be set to['mode/clojure/clojure'].The
+codeMirrorOptionskey contains all the CodeMirror options that will be set or changed by this plugin. New options can alse be declared viaCodeMirror.defineOption, and then have their value set here. For example, a plugin that enables line numbers would setcodeMirrorOptionsto{'lineNumbers': true}.Using the optional
+assetskey you may specify only CSS assets that should be loaded in the rendered HTML document. Check for example the Joplin Mermaid plugin to see how the data should be structured.One of the
+plugin,codeMirrorResources, orcodeMirrorOptionskeys must be provided for the plugin to be valid. Having multiple or all provided is also okay.See the demo plugin for an example of all these keys being used in one plugin.
+