Skip to content

Commit 497e716

Browse files
committed
Update README, release candidate and minor gulp fix
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.
1 parent 15116be commit 497e716

File tree

3 files changed

+15
-41
lines changed

3 files changed

+15
-41
lines changed

README.md

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
[![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)
44

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

97
## Introduction
108

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

4947
#### Dependencies
5048
* **Ruby**: `>2.0` with Bundler `>1.10`
51-
* **Node**: `>4.2`, Gulp `>4.0` and Yo `>1.7.0`
52-
* **Gulp:** Since the beta is running Gulp 4.0 you need to install `gulp-cli`:
53-
`npm install gulpjs/gulp-cli#4.0 -g`
54-
* **Jekyllized:** Then install Jekyllized: `npm install
55-
generator-jekyllized@next -g`
49+
* **Node**: `>4.2` and Yo `>1.7.0`
50+
* **Gulp:** Since the release candidate is running Gulp 4.0 you need to install
51+
`gulp-cli`: `npm install gulp-cli -g`
52+
* **Jekyllized:** Then install Jekyllized: `npm install generator-jekyllized -g`
5653

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

161158
Deletes your assets from their `.tmp` directory as well as in `dist` and deletes
162159
any gzipped files. **NOTE:** Does not delete your images from `.tmp` to reduce
163-
the time to build your site due to image optimizations. Note that `gulp clean`
164-
is built on top of a few other commands that you can run individually if that is
165-
more to your liking.
166-
167-
> `gulp clean:assets`
168-
169-
Erases out your assets from `.tmp` and `dist` but does not remove images.
170-
171-
> `gulp clean:images`
172-
173-
Erases your images from `.tmp` and `dist`.
174-
175-
> `gulp clean:dist`
176-
177-
Erases your `dist` folder.
178-
179-
> `gulp clean:gzip`
180-
181-
Erases any gzipped files in your `dist` folder.
182-
183-
> `gulp clean:metadata`
184-
185-
Deletes the `.jekyll-metadata` file, this will force Jekyll to completely
186-
rebuild your site.
160+
the time to build your site due to image optimizations.
187161

188162
#### `gulp rebuild`
189163

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

193168
### Subtasks
194169

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

272247
[awspublish]: https://github.com/pgherveou/gulp-awspublish
273-
[bower]: http://bower.io
274248
[browsersync]: https://github.com/shakyShane/browser-sync
275249
[browsersync-open]: https://browsersync.io/docs/options/#option-open
276-
[contribute]: https://github.com/sondr3/generator-jekyllized/blob/beta/CONTRIBUTING.md
250+
[contribute]: https://github.com/sondr3/generator-jekyllized/blob/master/CONTRIBUTING.md
277251
[changelog]: https://github.com/sondr3/generator-jekyllized/blob/master/CHANGELOG.md
278252
[frequentlyasked]: https://github.com/sondr3/generator-jekyllized#frequently-asked-questions
279253
[gulp]: http://gulpjs.com/
280-
[gulpfile]: https://github.com/sondr3/generator-jekyllized/blob/beta/generators/gulp/templates/gulpfile.babel.js
254+
[gulpfile]: https://github.com/sondr3/generator-jekyllized/blob/master/generators/gulp/templates/gulpfile.js
281255
[inject]: https://github.com/klei/gulp-inject
282256
[jekyll-url]: http://jekyllrb.com/docs/github-pages/#project-page-url-structure
283257
[jekyll]: https://jekyllrb.com

generators/gulp/templates/gulpfile.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -306,9 +306,9 @@ gulp.task('build', gulp.series(
306306
gulp.series('html')
307307
));
308308

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

313313
// 'gulp check' -- checks your Jekyll configuration for errors and lint your JS
314314
gulp.task('check', gulp.series('jekyll:doctor'));

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "generator-jekyllized",
3-
"version": "1.0.0-beta.23",
3+
"version": "1.0.0-rc.1",
44
"main": "index.js",
55
"description": "Use Jekyll with Gulp: Sass, sourcemaps, AutoPrefixer, asset optimization and cache busting and much, much more. Can you really want more?",
66
"keywords": [

0 commit comments

Comments
 (0)