https://github.com/liferay/electric

⚡ Create beautiful documentation for your projects
https://github.com/liferay/electric

electric

Last synced: 7 months ago
JSON representation

⚡ Create beautiful documentation for your projects

• Host: GitHub
• URL: https://github.com/liferay/electric
• Owner: liferay
• License: other
• Archived: true
• Created: 2017-01-05T19:17:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-20T07:48:14.000Z (almost 4 years ago)
• Last Synced: 2024-12-20T09:35:18.867Z (10 months ago)
• Topics: electric
• Language: JavaScript
• Homepage: https://electricjs.com
• Size: 8.23 MB
• Stars: 118
• Watchers: 23
• Forks: 26
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


# Electric

[![REUSE status](https://api.reuse.software/badge/github.com/electricjs/electric)](https://api.reuse.software/info/github.com/electricjs/electric)

> A static site generator powered by [soy templates](https://developers.google.com/closure/templates/), [metal.js](https://metaljs.com), and [marble](https://marblecss.com).

## Setup

1. Install NodeJS >= [v6.11.0](http://nodejs.org/dist/v6.11.0/), if you don't have it yet.

2. Install global dependencies:

	```

	[sudo] npm install -g yarn

	```

3. Install project dependencies:

	```

	yarn install

	```

4. Install dependencies for each package and link them together:

	```

	npm start

	```

5. Publish packages:

	```

	npm run publish

 	```

# License

```

SPDX-FileCopyrightText: © 2016 Liferay International Ltd. 

SPDX-License-Identifier: BSD-3-Clause

```