This page is part of a static HTML representation of the TiddlyWiki at

Installing custom plugins on Node.js

2nd November 2019 at 1:18pm
TiddlyWiki on Node.js

There are several ways in which custom plugins that are not part of TiddlyWiki's plugin library can be installed when using TiddlyWiki under Node.js. (See Installing a plugin from the plugin library for instructions on installing plugins from the library).

  • Arrange the PluginFolders containing the plugins in a convenient shared location and then use environment variables to tell TiddlyWiki to search those folders. The plugins can be referenced in by their name (e.g. tiddlytools/magic)
  • Place the PluginFolders containing the plugins in a plugins folder within the wiki folder. TiddlyWiki will attempt to include every subfolder as a plugin. Do not add the plugin names to Do not add the PluginFolders under a specific namespace:
    ├── plugins
    │   ├── relink
    │   │   ├── js
    │   │   ├──
    │   │   └── tiddlers
    │   └── relink-markdown
    │       ├── js
    │       ├──
    │       └── readme.tid
    ├── tiddlers
  • Depending on how TiddlyWiki itself has been installed, plugins can also be installed by copying the plugin folders into the plugins folder of the repository. This is only recommended if working with a forked copy of the repo. It is not recommended if TiddlyWiki has been installed with npm because npm is liable to overwrite the installation when performing an update

Note that including a plugin as an ordinary tiddler (e.g. by dragging and dropping a plugin into the browser) will result in the plugin only being active in the browser, and not available under Node.js.