An open API service indexing awesome lists of open source software.

https://github.com/rawnly/website-generator

Simple & Clean website generator
https://github.com/rawnly/website-generator

Last synced: 12 months ago
JSON representation

Simple & Clean website generator

Awesome Lists containing this project

README

          

# Website Generator
![example](img/generator.gif)
## Installation
To install _website-generator_ you must use **npm**
```bash
npm install -g website-generator
```

## How to
Enter in your project folder, and type the following

```bash
website && npm install
```

After this you shoud be able to use **gulp-cli**, have a live preview of the website and auto-compile **coffeescript** and **sass** into `dist/css` and `dist/js`.

### Note
1. Browser sync is setted to preview the **index.html** in `./dist` directory.
2. The Gulpfile [gist](https://gist.github.com/Rawnly/2ef55dfe57f2adbf065b7aa2b638ae9e) used for template.

## LICENSE ([MIT](https://github.com/Rawnly/website-generator/blob/master/LICENSE.md))

The MIT License (MIT)

Copyright (c) 2016 Federico Vitale

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.