|
2 | 2 |
|
3 | 3 | [](https://coveralls.io/r/sondr3/generator-jekyllized) [](https://gitter.im/sondr3/generator-jekyllized?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
4 | 4 |
|
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!*** |
8 | 6 |
|
9 | 7 | ## Introduction
|
10 | 8 |
|
@@ -48,11 +46,10 @@ new/updated site is uploaded to your platform of choice.
|
48 | 46 |
|
49 | 47 | #### Dependencies
|
50 | 48 | * **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` |
56 | 53 |
|
57 | 54 | #### Install
|
58 | 55 | * **Scaffold:** Run `yo jekyllized` in the directory you want scaffold your site
|
@@ -160,35 +157,13 @@ doctor` to look for potential errors.
|
160 | 157 |
|
161 | 158 | Deletes your assets from their `.tmp` directory as well as in `dist` and deletes
|
162 | 159 | 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. |
187 | 161 |
|
188 | 162 | #### `gulp rebuild`
|
189 | 163 |
|
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. |
192 | 167 |
|
193 | 168 | ### Subtasks
|
194 | 169 |
|
@@ -270,14 +245,13 @@ See the [contribution][contribute] docs.
|
270 | 245 | MIT © Sondre Nilsen (https://github.com/sondr3)
|
271 | 246 |
|
272 | 247 | [awspublish]: https://github.com/pgherveou/gulp-awspublish
|
273 |
| -[bower]: http://bower.io |
274 | 248 | [browsersync]: https://github.com/shakyShane/browser-sync
|
275 | 249 | [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 |
277 | 251 | [changelog]: https://github.com/sondr3/generator-jekyllized/blob/master/CHANGELOG.md
|
278 | 252 | [frequentlyasked]: https://github.com/sondr3/generator-jekyllized#frequently-asked-questions
|
279 | 253 | [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 |
281 | 255 | [inject]: https://github.com/klei/gulp-inject
|
282 | 256 | [jekyll-url]: http://jekyllrb.com/docs/github-pages/#project-page-url-structure
|
283 | 257 | [jekyll]: https://jekyllrb.com
|
|
0 commit comments