nirgn975 / generator-jekyll-starter-kit

🚀 Jekyll Progressive Web App Generator.

Jekyll + Google web-starter-kit = best of both worlds

Installation

First, install Yeoman and jekyll-starter-kit using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-jekyll-starter-kit

Then generate your new project:

yo jekyll-starter-kit

Features

• Automagically compile Pug
• Automagically compile Sass / SCSS
• Minify HTML
• Minify and Autoprefixing CSS
• Awesome image optimization before deploy
• Enable ES2015 features using Babel
• Concatenate and minify JavaScript
• Built-in preview server with BrowserSync
• Automagically create a service worker file for offline caching
• Deploy the project to GitHub pages or Firebase with only one command
• Automagically test your project output on GitHub Actions with html-proofer
• Test your project against lighthouse and fail GitHub Action with score below 80/100
• Awesome README file with all instructions and badges - like the pros 😉

Trouble with running the project?

There's could be an issue with Gem package manager and the gems on your local machine. If so, run:

bundle install

For more info about bundle go to Bundler.

Want to help?

Great! Here is how you can install the local generator to test changes.

1. Git clone your fork locally.
2. npm install inside the new directory.
3. npm link - This makes your local system sync with the changes you make
4. mkdir app
5. Inside the new directory, initiate yo jekyll-starter-kit

Contributors

• Nir Galon
• Roy Segall
• Yotam Emergy
• Carol Ng

generator-jekyll-starter-kit's Issues

Add generator to project name.

Fix gitter change link

Miscellaneous

• Add _layouts directory .
• Add _includes directory with nav and footer.
• Make sure all *.html files have an *.pug.
• Create robots.txt file.

Upgrade Jekyll to version 3.7.2

This is a ... (check one with "x")

[ ] Bug report
[x] Feature request
[ ] Clarification on the documentation

Current behavior
Jekyll is on 3.6.2

What is the expected behavior? (if you know how it should behave)
Jekyll should be on 3.7.2

Add offline support.

Current issues:

• When deploy to firebase, 404.html file doesn't recognize.

Update Jekyll to 3.6

Fix gitignore copy file.

Fix gulp task

Auto Deploy to npm

This is a ... (check one with "x")

[ ] Bug report
[x] Feature request
[ ] Clarification on the documentation

Current behavior
The deploy of a new version to npm registry is manually.

What is the expected behavior? (if you know how it should behave)
The deploy of a new version to npm registry should happen automatically with travis-ci after all the tests are done, and only if there is a new release.

Upgrade Jekyll and more

• Upgrade Jekyll to version 3.6.2.
• Add Carol Ng to the Contributors section.
• Add .github directory with issue and pull request templates.
• Upgrade npm version.
• Update npm packages.

Upgrade dependencies

This is a ... (check one with "x")

[ ] Bug report
[x] Feature request
[ ] Clarification on the documentation

Current behavior

What is the expected behavior? (if you know how it should behave)

Not an issue but a feature request

anything on the road map to add CSSNext with PostCSS plugins instead of Sass/Scss ?

Add `img-minify` gulp task

Add gitter badge

Add deploy task.

Add an option to deploy to:

• GitHub pages.
• Firebase

Fix README

Add ES2015

If the user choose to add ES2015, add support of it with babel.

User babel in gulpfile.

• Add babel.
• Prompt the user for ES2015 (babel) or not.
• Remove 0.12 and 0.10 from .travis file.
• Getting To Know Yeoman section from README.md file.
• Edit the package.json of the template project.
• Add LICENSE file to the template project.

Exclude validate directory from site build

• Add validate directory to the exclude array in _config.yml file.
• Fix relative_url and absolute_url.

Jekyll 3.3.0 features

Use relative_url and absolute_url in GitHub pages.
What's new in GitHub Pages with Jekyll 3.3

Fix logo image in README file.

Task 'default' is not in your gulpfile

Was getting the below:

npm run gulp

> [email protected] gulp /Users/ed/Sites/epluno
> gulp

[08:35:09] Requiring external module babel-register
[08:35:10] Using gulpfile ~/Sites/epluno/gulpfile.babel.js
[08:35:10] Task 'default' is not in your gulpfile
[08:35:10] Please check the documentation for proper gulpfile formatting

I run npm install --save-dev babel-register resolved the default task error but running npm run gulp starts and finishes after almost no time...

ServiceWorker deploy fixes.

Update PayPal badge

Update maintenance badge for 2018

This is a ... (check one with "x")

[x] Bug report
[ ] Feature request
[ ] Clarification on the documentation

Current behavior
Update maintenance badge for 2018.

What is the expected behavior? (if you know how it should behave)
The badge is for 2017, so the maintenance status is on stale

Add art work.

Add the logo of the project to the README.md file.

Bug with gulp-shell

Hi ! When i run npm start and it have a problem

Error in plugin "gulp-shell"
Message:
    Command `jekyll build` failed with exit code 127

Anything to fix this? Thanks

Add Paypal donate button

Fix Travis-CI in generated project.

Edit humans.txt.

Switch from coverall to codecov

Fix gulp deploy tasks.

Remove the generator from the project name.

Add basic Jekyll site.

Test different configurations

Test all the different configurations with mocha.

What works for now:

• html / pug (jade)
• css / sass / scss
• travis

Handle CSS/SASS/SCSS

• Add gulp task for SASS/SCSS to css.
• Add gulp task to minify and autoprefix css.

Edit badges and add feature section

Fix gitter:

Add Features section:

## Features

* Automagically compile [Pug](https://github.com/pugjs/pug) [optional]
* Automagically compile Sass / SCSS
* Minify HTML
* Minify and Autoprefixing CSS
* Awesome image optimization before deploy
* Enable ES2015 features using Babel
* Concatenate and minify JavaScript
* Built-in preview server with BrowserSync
* Automagically create a service worker file
* Deploy the project to GitHub pages or Firebase with only one command
* Automagically test your project output on Travis-CI
* Test your project against [lighthouse](https://github.com/GoogleChrome/lighthouse) and fail Travis-CI with score below 80

Update Jekyll and other dependencies

This is a ... (check one with "x")

[ ] Bug report
[x] Feature request
[ ] Clarification on the documentation

Current behavior
Old version of Jekyll.

What is the expected behavior? (if you know how it should behave)
Most updated version of Jekyll.

Check PWA with lighthouse

Lighthouse GitHub repo.

Clear the output website directory when build

• Create a gulp task to delete the _site directory.
• Add this task at the start of the build and deploy tasks.
• Update dependencies.

Fix Travis of generated project.

Why tell the user to run bower install when there is no bower file exists?

After the project was generated the CLI wrote to run bower install but there is notbower.json file. Is there a special reason or it's removable?

Add browser-sync

• Watch HTML / Pug (Jade).
• Watch css / sass / scss.
• Inject (realod) changes.

Release new version.

Update dependencies

Handel HTML.

• Build Jekyll.
• Minify HTML.
• Convert Jade to HTML

Update README file

Update the Development mode section to run $ npm run gulp serve

Change name to support yeoman generator.

Add travis.

Create publish and released version.