Awesome Open Source
Awesome Open Source

license GitHub release (latest by date) semantic-release Continuous Deployment Dependency Status codecov Codacy Badge Maintenance

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

npm


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,537,981
Scss (16,206
Firebase (9,134
Automation (6,600
Generator (3,733
Jekyll (3,423
Travis Ci (1,697
Pug (1,460
Starter Kit (1,389
Progressive Web App (928
Best Practices (868
Service Worker (771
Gh Pages (608
Es2015 (515
Seed (494
Yeoman (482
Project Template (317
Related Projects