This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

Installing a plugin from the plugin library

22nd October 2019 at 9:56am
Plugins TiddlyWiki on Node.js

Standalone Configuration

Follow these instructions when using TiddlyWiki as a standalone HTML file:

  1. Create a backup of your current TiddlyWiki HTML file (just in case)
  2. Open your TiddlyWiki in a browser
  3. Open the control panel , click on the Plugins tab and then the Get more plugins button
  4. Click open plugin library to open the official plugin library
  5. When the library listing is loaded:
    1. Use the tab to select between plugins, themes and languages
    2. Use the search box to search the plugin details
  6. Click the install button to install a plugin
  7. Save your TiddlyWiki
  8. If a yellow warning bar appears at the top of the window, refresh the window so that TiddlyWiki completes installation of the plugin
    • New in: 5.1.22 It is no longer necessary to refresh TiddlyWiki when deleting plugins that support dynamic loading. See PluginMechanism for more details
  9. The plugin should now be available for use

Client-Server Configuration

Follow these instructions when using TiddlyWiki under Node.js:

  1. Identify the plugins you want to install using the Plugins tab of control panel (don't install the plugins from here, though). Plugins are identified by their type (ie language, theme or plugin) and their publisher and title. For example, the plugin $:/plugins/tiddlywiki/internals is referred to as tiddlywiki/internals
  2. Quit the server if it is running
  3. Edit the tiddlywiki.info file (it is in JSON format) and locate the plugins, themes or languages section (see below)
  4. Add entries corresponding to the plugins you wish to add. Take care to retain commas to separate items, but do not terminate the last item in a list with a comma
  5. Restart the server
{
	"plugins": [
		"tiddlywiki/codemirror"
	],
	"themes": [
		"tiddlywiki/vanilla",
		"tiddlywiki/snowwhite"
	],
    "languages": [
        "es-ES",
        "fr-FR",
        "en-EN"
    ]
}

See also Installing custom plugins on Node.js.