Generator Jekyll Starter Kit

Overview

The Jekyll + Google web-starter-kit is a powerful web development theme that combines the features of Jekyll, a static site generator, and Google web-starter-kit. It offers a range of useful features for web developers, including automatic compilation of Pug and Sass / SCSS files, minification of HTML and CSS, image optimization, ES2015 feature support, concatenation and minification of JavaScript, preview server with BrowserSync, creation of a service worker file for offline caching, deployment to GitHub Pages or Firebase, automated testing using GitHub Actions, and the generation of an insightful README file with instructions and badges.

Features

• Automagically compile Pug: Automatically compiles Pug files for easy template management.
• Automagically compile Sass / SCSS: Automatically compiles Sass / SCSS files for improved CSS development.
• Minify HTML: Minifies HTML files to reduce their file size and improve page loading speed.
• Minify and Autoprefixing CSS: Minifies CSS files and applies autoprefixing for browser compatibility.
• Awesome image optimization before deploy: Optimizes images before deployment for improved performance.
• Enable ES2015 features using Babel: Enables the use of ES2015 (ES6) features using Babel.
• Concatenate and minify JavaScript: Concatenates and minifies JavaScript files to improve page load time.
• Built-in preview server with BrowserSync: Provides a built-in preview server with BrowserSync for live development and testing.
• Automagically create a service worker file for offline caching: Automatically creates a service worker file for offline caching of web assets.
• Deploy the project to GitHub pages or Firebase with only one command: Simplifies the deployment process to GitHub Pages or Firebase with a single command.
• Automagically test your project output on GitHub Actions with html-proofer: Automates the testing of the project output using GitHub Actions and html-proofer.
• Test your project against lighthouse and fail GitHub Action with score below 80/100: Tests the project against lighthouse and fails GitHub Actions if the score falls below 80/100.
• Awesome README file with all instructions and badges: Generates an informative README file with instructions and badges to enhance project documentation.

Installation

To install the Jekyll + Google web-starter-kit, follow these steps:

1. Install Yeoman and jekyll-starter-kit using npm (Assuming you have pre-installed Node.js):

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

2. Generate your new project:

   yo jekyll-starter-kit
   

Summary

The Jekyll + Google web-starter-kit is a comprehensive web development theme that combines the power of Jekyll and Google web-starter-kit. It provides developers with an easy-to-use toolset for building static websites with features such as automatic compilation of Pug and Sass / SCSS, minification of HTML and CSS, image optimization, ES2015 support, concatenation and minification of JavaScript, a preview server with BrowserSync, offline caching with service workers, easy deployment to GitHub Pages or Firebase, automated testing using GitHub Actions, and a well-documented README file. By leveraging these features, developers can streamline their web development process and create high-performance static websites.