gulp-jekyll-stream
Stream a compiled Jekyll site with Gulp
Forked from gulp-jekyll
Example
Example gulpfile.js
, shown with defaults:
const gulp = ;const jekyll = ; gulp;
If you are using GitHub Pages with the recommended method, then you'll want bundleExec: true
.
gulp-jekyll
vs. You'd want to use this package instead of gulp-jekyll
if you want to pipe Jekyll's output somewhere.
The main differences are:
- You must provide a directory path using
gulp.src()
(or thesource
property) to the plugin; Jekyll operates on entire directories; not files! - The output of this stream is all the files which Jekyll generated
- If you neglect to pipe this plugin's output, and do not specify the
destination
property, the generated site disappears into the ether
Installation
Prerequisites
npm install gulp-jekyll-stream gulp -D
History
- v1.0.0:
- New features:
- Support any and all
jekyll
command-line options
- Support any and all
- Bug fixes?
- Maybe Windows support via cross-spawn
- Breaking changes:
- Update dependencies
- Update dev depenedncies
- Require Node.js v6 or newer
- New features:
- v0.1.0: Initial Release
Author
Christopher Hiller, based on code by Danny Garcia.
License
MIT