This repository has been archived by the owner on Nov 3, 2021. It is now read-only.

Name		Name	Last commit message	Last commit date
parent directory ..
generators/app		generators/app
README.md		README.md
package-lock.json		package-lock.json
package-lock.json.license		package-lock.json.license
package.json		package.json
package.json.license		package.json.license

README.md

Electric.js Generator

Yeoman generator for creating documentation sites using electric.js.

Dependencies

Install Node if you haven't yet, then run this command to install global npm dependencies.

npm i -g electric-cli yo

Install

npm i -g generator-electric

Development

npm link

Run

yo electric

Once the folder has been created, npm will install the dependendencies.

Run electric run to generate the site and start a development server.

Please see electricjs.com for more documentation.