Extend Inkdrop with Plugins

Plugins add new functionality or provide new look to Inkdrop. You can activate or deactivate them at any time. Go to 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:

  • General plugin - Plugin that adds new functionality
  • UI Theme - Theme for Inkdrop UI
  • Preview Theme - Theme for Markdown preview

Using ipm (Inkdrop Plugin Manager)

Currently Inkdrop doesn't provide GUI for installing/uninstalling plugins. It's planned to support in the future.
ipm is a fork of apm (atom package manager), some output messages may include Atom-related though, please ignore them. 😉

ipm is a command-line tool to manage plugins for Inkdrop.

macOS

When you first open Inkdrop, it will try to install the ipm command for use in the terminal. If the ipm command has been installed, you'll see something like this:

$ which ipm
/usr/local/bin/ipm

You can also manually install ipm from Inkdrop -> Install Shell Commands from the menubar.

Windows

The setup program will install ipm, and add it to your PATH.

Linux

ipm is not installed automatically. The command is available in the path of <path-to-inkdrop>/resources/app/ipm/bin/ipm.

Finding new plugins

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://www.inkdrop.info/plugins to read more about them.

Installing plugins

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.

For example ipm install markdown-emoji@0.1.0 installs the 0.1.0 release of the markdown-emoji package.

Activating plugins

Go to 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.

Activating Plugins

Uninstalling plugins

You can also uninstall the plugin by running below command:

$ ipm uninstall <package_name>

Can you help us improve these docs?

The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!