Coffee Help
All topics

Help Plugins and automation

Writing a plugin

Mac

A plugin is a folder with a manifest and a JavaScript file. The plugin guide explains the API, the permissions and how to send one to the directory.

How to start

  1. Read the plugin guide. It describes the manifest, the JavaScript API and each permission.
  2. Make a folder for your plugin with its manifest and its JavaScript file, as the guide shows.
  3. Ask only for the permissions it needs. People see them in plain words before they turn it on: read other notes, change other notes, or connect to a named site.
  4. When it works, send it to the directory as the guide explains. Plugins there are reviewed by Coffee.

Good to know

  • Plugins run on the Mac only.
  • A plugin can add buttons to the top bar, commands with their own shortcuts, sidebar sections, marks in the text, code blocks drawn as pictures and a settings page. See plugins.
  • Looking at the plugins already in the directory is a good way to see what's possible.

Not what you needed? Write to a person.