Welcome to Inkdrop! These docs give an overview of how Inkdrop works, and are meant to be a reference for plugin developers.
The Inkdrop Forum is the place to discuss anything and everything Inkdrop related with the entire Inkdrop community. If you have problems or are looking for help, this is your place.
Plugins add new functionality or provide new look to Inkdrop. You can activate or deactivate them at any time.
Preferences > Plugins on macOS or
File > Settings on Windows and Linux to see a list of what’s installed.
To find new plugins to install, please access to Inkdrop plugin registry.
Developers can clone or download additional Inkdrop plugins via GitHub. Installation instructions are here. Many of these are community-contributed, and the selection will continue to grow over time.
There are three types of the plugin:
ipm is a command-line tool to manage plugins for Inkdrop.
When you first open Inkdrop, it will try to install the
ipm command for use in the terminal.
ipm command has been installed, you'll see something like this:
$ which ipm /usr/local/bin/ipm
You can also manually install
Inkdrop -> Install Shell Commands from the menubar.
The setup program will install
ipm, and add it to your
ipm is not installed automatically. The command is available in the path of
<path-to-inkdrop>/resources/app/ipm/bin/ipm. For example, on Ubuntu the path to ipm is
You can also use
ipm to find new plugins to install. If you run
ipm search, you can search the plugin registry for a search term.
$ ipm search emoji Search Results For 'emoji' (1) └── markdown-emoji Add emoji syntax support to Inkdrop markdown editor (0 downloads, 0 stars) Use `ipm install` to install them or visit https://my.inkdrop.app/plugins to read more about them.
Once you found new plugins to install, you can install them by using the
ipm install command:
ipm install <package_name>to install the latest version.
ipm install <package_name>@<package_version>to install a specific version.
ipm install email@example.com installs the 0.1.0 release of the markdown-emoji package.
Preferences > Plugins (macOS) or
File > Settings (Windows and Linux), you can activate/deactivate plugins by toggling a switch on the left of the plugin name here.
You can also uninstall the plugin by running below command:
$ ipm uninstall <package_name>
The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!