Skip to content

Plugin Installation

Matthew Davis edited this page Apr 22, 2016 · 3 revisions

Installation

Plugins are installed via npm at command line. Change your working directory to the version of uniformity you wish to install the plugin in.

Installation is handled by uniformity itself to ensure that the package is an actual uniformity plugin. This is done through uniformity's 'plugin' script:

$ npm run plugin 'plugin-name'

Manual Installation

Under certain conditions such as no internet and creating/testing plugins, plugins can be installed manually without the use of npm or the plugin manager.

All plugins are handled as node_modules and need to be simulated as such. The plugin manager works by loading the array of plugin names saved at ./config/config.json. This list require()s each named element and uniformity uses the Plugin where ever it is needed, as specified in the Plugin itself.

In simple terms:

  1. Add the manual plugin and it's dependencies to the node_modules directory.
  2. Add the plugin name to ./config/config.json, e.g.: {"pluginManager": {"pluginList": ["uniformity-blog"]}}
Clone this wiki locally