A Yeoman generator for Jekyll to rapidly build sites using Gulp
NOTE: Currently using gulp 4.0 which is in beta!
generator-jekyllized is a very opinionated Yeoman generator built
with Jekyll and gulp. You will be able to quickly scaffold
your site and start developing. As you are working on your site your assets will
automatically be updated and injected into your browser as well as your posts.
When you are done developing and want to publish it you are two commands away
from having everything optimized and published.
Built on top of Jekyll 3, you get a mature and stable base with the full power that Jekyll brings you. You'll have sitemaps, Atom feeds generated and SEO meta data tags added to your posts and pages.
Optimize your assets
When you are done developing you can have your assets optimized and injected correctly into your HTML. Your assets will be minified, compressed with gzip, cache busted and otherwise optimized. Your images will be run through compressors to save space and even your HTML will be minified.
Finally, once everything is done and you are ready to publish your site, you can do it via either Amazon S3, Github Pages or Rsync. With a single command your new/updated site is uploaded to your platform of choice.
npm install gulp-cli -g
npm install generator-jekyllized -g
yo jekyllizedin the directory you want scaffold your site in
gulpand watch the magic unfold
It's recommended that you keep your gulp tasks and packages up to date, luckily
this is very easy with
genertor-jekyllized! All you need to do is run
yo jekyllized:update and you'll be up to date. If you want to skip the
installation and only update you can run it with
yo jekyllized:update will overwrite any changes made to
and your gulp files, so back them up!
This is the default command, and probably the one you'll use the most. This command will build your assets and site with development settings. You'll get sourcemaps, your drafts will be generated and you'll only generate the last 10 posts (for speed). As you are changing your posts, pages and assets they will automatically update and inject into your browser via BrowserSync.
Once you are done and want to verify that everything works with production
settings you add the flag
--prod and your assets will be optimized. Your CSS,
JS and HTML will be minified and gzipped, plus the CSS and JS will be cache
busted. The images will be compressed and Jekyll will generate a site with all
your posts and no drafts.
This command is identical to the normal
gulp [--prod] however it will not
create a BrowserSync session in your browser.
gulp jekyll [--prod]
Without production settings Jekyll will only create the 10 latest posts and will
create both future posts and drafts. With
--prod none of that is true and it
will generate all your posts.
gulp styles|scripts [--prod]
Both your CSS and JS will have sourcemaps generated for them under development settings. Once you generate them with production settings sourcemap generation is disabled. Both will be minified, gzipped and cache busted with production settings.
Optimizes and caches your images. This is a set it and forget it command for the most part.
gulp html --prod
Does nothing without
--prod. Minifies and gzips your HTML files.
If you just want to watch your site you can run this command. If wanted you can
also edit the
serve task to allow it to tunnel via localtunnel
so people outside your local network can view it as well:
// tunnel: true,
You can also change the behaviour for how it opens the URL when you run
gulp [--prod], you can see the options here:
// open: false,
When you're done developing and have built your site with either
gulp build --prod you can deploy your site to either Amazon S3, Github
Pages or with Rsync.
Amazon S3 and Rsync
If you chose either of these two, you'll have a
file in your root folder that you have to fill out. It should be pretty self
explanatory, however, if you need any help with configuring it, you should check
out either the
gulp-awspublish repo or
repo for help.
If you chose to upload to Github Pages there's no configuration besides starting
a git repo in your folder, setting an
origin remote repo and run
gulp deploy. Your site will be automatically pushed to Github. See the
FAQ for configuring personal repos vs project repos.
jekyll 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.
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.
All of the subtasks lives in their own files in the
gulp directory and are
named after what they do. You can edit or look at any of them to see how they
actually work. They're all commented.
index.js and a
vendor.js file with files from [Bower][bower] you can do this quite easily. Create a
copy of the
scripts gulp task and rename it to
scripts:vendor and change the
gulp.src files you need:
and then change
.pipe($.concat('vendor.js')). Then you go to the bottom of the gulpfile and
scripts:vendor task that has been added. Also be ware that things
are injected in alphabetical order, so if you need your vendor scripts before
index.js file you have to either rename the
index.js file or rename the
vendor.js file. When you now run
gulp build it will create a
vendor.js file and automatically inject it at the bottom of your HTML. When
--prod it'll automatically optimize and such as well.
For more advanced uses, refer to the
gulp-inject documentation on
how to create individual inject tags and inject specific files into them.
Github Pages configuration
By default if you select Github Pages as your deployment option your site will
be pushed to a
gh-pages branch, this works fine for any project pages but
won't work for your personal repo. If you want to use a
site you'll have to change it to this:
You might also have to configure the URL for your site if you want to use Github Pages. Luckily the Jekyll documentation has you covered.
Why don't you support Stylus/LESS/Angular/etc
Because I've never used them nor do I have any plans of using them. Furthermore, they're a bit outside what I want with this generator anyways. I want a lean, simple and opinionated generator, not a big complicated one.
See the contribution docs.
MIT © Sondre Nilsen (https://github.com/sondr3)