Skip to content

Commit

Permalink
Update README, release candidate and minor gulp fix
Browse files Browse the repository at this point in the history
Make sure everything is ready for releasing the first release candidate
of this generator. Also updated the rebuild task to also clean out the
temporary jekyll site.
  • Loading branch information
sondr3 committed May 29, 2016
1 parent 15116be commit 497e716
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 41 deletions.
48 changes: 11 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

[![Coverage Status](https://coveralls.io/repos/sondr3/generator-jekyllized/badge.png)](https://coveralls.io/r/sondr3/generator-jekyllized) [![Gitter](https://badges.gitter.im/sondr3/generator-jekyllized.svg)](https://gitter.im/sondr3/generator-jekyllized?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

*Waiting on Gulp 4.0 to be released for the beta to go back to being the main
version of Jekyllized. If you want to try it as it is right now you can install
it from NPM under the `next` tag. Just read the installation instructions!*
***NOTE: Currently using gulp 4.0 which is in beta!***

## Introduction

Expand Down Expand Up @@ -48,11 +46,10 @@ new/updated site is uploaded to your platform of choice.

#### Dependencies
* **Ruby**: `>2.0` with Bundler `>1.10`
* **Node**: `>4.2`, Gulp `>4.0` and Yo `>1.7.0`
* **Gulp:** Since the beta is running Gulp 4.0 you need to install `gulp-cli`:
`npm install gulpjs/gulp-cli#4.0 -g`
* **Jekyllized:** Then install Jekyllized: `npm install
generator-jekyllized@next -g`
* **Node**: `>4.2` and Yo `>1.7.0`
* **Gulp:** Since the release candidate is running Gulp 4.0 you need to install
`gulp-cli`: `npm install gulp-cli -g`
* **Jekyllized:** Then install Jekyllized: `npm install generator-jekyllized -g`

#### Install
* **Scaffold:** Run `yo jekyllized` in the directory you want scaffold your site
Expand Down Expand Up @@ -160,35 +157,13 @@ doctor` to look for potential errors.

Deletes your assets from their `.tmp` directory as well as in `dist` and deletes
any gzipped files. **NOTE:** Does not delete your images from `.tmp` to reduce
the time to build your site due to image optimizations. Note that `gulp clean`
is built on top of a few other commands that you can run individually if that is
more to your liking.

> `gulp clean:assets`
Erases out your assets from `.tmp` and `dist` but does not remove images.

> `gulp clean:images`
Erases your images from `.tmp` and `dist`.

> `gulp clean:dist`
Erases your `dist` folder.

> `gulp clean:gzip`
Erases any gzipped files in your `dist` folder.

> `gulp clean:metadata`
Deletes the `.jekyll-metadata` file, this will force Jekyll to completely
rebuild your site.
the time to build your site due to image optimizations.

#### `gulp rebuild`

Only run when you need to do a full rebuild! This will delete your built site
and all the assets with it.
Only use this if you want to regenerate everything, this will delete everything
generated. Images, assets, your Jekyll site. You really shouldn't need to do
this.

### Subtasks

Expand Down Expand Up @@ -270,14 +245,13 @@ See the [contribution][contribute] docs.
MIT © Sondre Nilsen (https://github.com/sondr3)

[awspublish]: https://github.com/pgherveou/gulp-awspublish
[bower]: http://bower.io
[browsersync]: https://github.com/shakyShane/browser-sync
[browsersync-open]: https://browsersync.io/docs/options/#option-open
[contribute]: https://github.com/sondr3/generator-jekyllized/blob/beta/CONTRIBUTING.md
[contribute]: https://github.com/sondr3/generator-jekyllized/blob/master/CONTRIBUTING.md
[changelog]: https://github.com/sondr3/generator-jekyllized/blob/master/CHANGELOG.md
[frequentlyasked]: https://github.com/sondr3/generator-jekyllized#frequently-asked-questions
[gulp]: http://gulpjs.com/
[gulpfile]: https://github.com/sondr3/generator-jekyllized/blob/beta/generators/gulp/templates/gulpfile.babel.js
[gulpfile]: https://github.com/sondr3/generator-jekyllized/blob/master/generators/gulp/templates/gulpfile.js
[inject]: https://github.com/klei/gulp-inject
[jekyll-url]: http://jekyllrb.com/docs/github-pages/#project-page-url-structure
[jekyll]: https://jekyllrb.com
Expand Down
6 changes: 3 additions & 3 deletions generators/gulp/templates/gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -306,9 +306,9 @@ gulp.task('build', gulp.series(
gulp.series('html')
));

// 'gulp rebuild' -- WARNING: Erases your assets and built site, use only when
// you need to do a complete rebuild
gulp.task('rebuild', gulp.series('clean:dist', 'clean:assets', 'clean:images'));
// 'gulp rebuild' -- WARNING: Erases everything besides your 'src' directory,
// so everything is nuked from orbit
gulp.task('rebuild', gulp.series('clean:dist', 'clean:assets', 'clean:images', 'clean:jekyll'));

// 'gulp check' -- checks your Jekyll configuration for errors and lint your JS
gulp.task('check', gulp.series('jekyll:doctor'));
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-jekyllized",
"version": "1.0.0-beta.23",
"version": "1.0.0-rc.1",
"main": "index.js",
"description": "Use Jekyll with Gulp: Sass, sourcemaps, AutoPrefixer, asset optimization and cache busting and much, much more. Can you really want more?",
"keywords": [
Expand Down

0 comments on commit 497e716

Please sign in to comment.