Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastiandedeyne/guss
Gulp powered static site generator, based on jekyll and very opinionated
https://github.com/sebastiandedeyne/guss
Last synced: 14 days ago
JSON representation
Gulp powered static site generator, based on jekyll and very opinionated
- Host: GitHub
- URL: https://github.com/sebastiandedeyne/guss
- Owner: sebastiandedeyne
- License: mit
- Created: 2014-12-06T00:45:50.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-26T12:04:11.000Z (over 9 years ago)
- Last Synced: 2024-10-17T16:06:48.795Z (27 days ago)
- Language: CoffeeScript
- Size: 152 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guss
*Gulp powered static site generator, based on jekyll and very opinionated*
## Overview
Guss compiles the bootstrapped folders into a ready-for-production website. Each folder's content is treated differently.
```
views
```
Swig templated come here. Layouts can be registered in `views/_layouts`. Views van contain front matter which cascade to the top layout.
```
assets
```
Assets' contents get copied straight to the destination folder. Story your favicons, .htaccess, images, etc. here.
```
assets-static
```
Static assets behave the same as assets, but aren't watched for changes during development. This is useful to reduce long build times when including large files or php libraries.
```
css
```
Sass-files are automatically compiled, linked svg's are base64-encoded, css-files are copied.
```
js
```
Coffeescript files are automatically compiled. `gulp-include` is also enabled here, this is very useful to include dependencies from bower without adding bloat (take a look at `js/lib/jquery` for an example).
## Installation
```
$ npm install [&& bower install]
```
*Note: if you don't want to use bower, you'll have to remove the files in `js/lib` which include bower packages.*
## Usage
```
$ gulp build [--production]
```
Generate the site to the destination set in `config/gulpfile.coffee`. By default this is `_site`.
```
$ gulp serve
```
Serve the site at `http://localhost:8000` and watch for changes.
## Configuration
Configuration is stored in `config.site.yml` and/or `config.local.yml`. The local configuration file is gitignored for personal configuration. It's content overwrites the site configuration.
### Options
- destination (**_site**)
- pretty_permalinks (**true**|false)
- server_port (**8000**)
- livereload (**true**)
## Future features
- Upgrade to gulp 4.0
- Support partial views