Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wandrewkeech/gulp-pugitude
A static site generator platform made with Pug (Jade), Sass, and Live-Server
https://github.com/wandrewkeech/gulp-pugitude
Last synced: 22 days ago
JSON representation
A static site generator platform made with Pug (Jade), Sass, and Live-Server
- Host: GitHub
- URL: https://github.com/wandrewkeech/gulp-pugitude
- Owner: wandrewkeech
- License: isc
- Created: 2016-03-20T06:25:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-10T17:30:05.000Z (over 7 years ago)
- Last Synced: 2024-10-15T14:32:19.669Z (about 1 month ago)
- Language: HTML
- Size: 6.8 MB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Gulp-Pugitude
#### The easy-to-use Static Site Generator that uses Pug (jade-lang), Sass, and Live-Server with Gulp
The content in this repository will be mostly the `gulpfile`, `pug` template
demos, and a wiki perhaps. So far I am still learning how to package with npm
(this is a spare time project, and I'm no professional and have no idea what I'm
doing).
Pugitude is all about putting together the straight-forward static site
generator that I wish already existed. Where most any other offering is
oriented toward blog content, Pugitude makes no assumptions about your content,
so there's no opinion to work around. I wanted to make a generator that would
allow making portfolio or gallery sites sensible and streamlined.
## Installation
Cloning this repo is probably the best idea. First install NodeJS (I suggest
with a tool like the wonderful [nvm](https://github.com/creationix/nvm)).
Navigate to your working directory, and use git to install:
```bash
$ git clone [email protected]:wandrewkeech/gulp-pugitude
```
Then rename the new `gulp-pugitude/` folder to your project's name so it's
how you want it. Now finally, use `npm` to install the dependencies and a global
copy of gulp (I have no idea why the in-directory copy does not seem to work):
```bash
$ npm install --save-dev
$ npm install -g gulp
```
## Useage
Generating the demo content is done with a straight-forward
```bash
$ gulp
```
which should build all the content first (which automatically mirrors the
structure of your source directory tree), watch all source directories, fire up
`live-server`, and open your browser. Updates ~~will appear automatically and very
quickly in your browser window (as soon as I fix the bug with running
`live-server` from within `gulp`)~~ need to be revealed manually on reload.
## Issues
- [ ] Build a comprehensive demo of `pug` features and use in the demo project
- [x] ~~Build a `sass` theme for the demo project (likely borrow from
http://www.jade-lang.com )~~ Use a framework like a normal person and
do a tiny bit of work to demonstrate it and modify it
- [ ] ~~Get automatic refresh in browser with live-server working with `gulp`~~
- [x] Perhaps have an error-catching call back to prevent `gulp` from exiting on
a `pug` rendering error, if the user saves with a typo (or other syntax
problems)
- [x] De-breakify this repo as it was, and come up with a conceivable way for
other people to try the setup out
## Deps and Links
- [Vanilla Framework](https://docs.vanilla-framework.io)
- [Gulp](https://www.npmjs.com/package/gulp)
- [Live Server](https://www.npmjs.com/package/live-server)
- [Pug](http://www.jade-lang.com)
- [Sass](http://www.sass-lang.com)