sawyerh / jekyll-boilerplate

Helpful files to get started working on a new Jekyll website

This repo includes a boilerplate for getting started working on a new Jekyll website, setup for GitHub Pages. It includes the following, which I tend to need on any site I work on:

• Package management using NPM
• ESLint + Stylelint
• JS testing using Jest
• Automatic code and Markdown formatting using Prettier
• Git hooks using Husky
• ES6 transpiling and bundling using Webpack and Babel
• Sass transpiling and processing using PostCSS
• Local server and live reloading using Browsersync

Prerequisites

• Git - This boilerplate uses the github-pages gem, which expects a Git repo to be configured locally
• Node 10.x +
• Ruby 2.4.x +

Installation

npm install

Usage

Local development

Run a local Jekyll server and enjoy live reloading:

npm start

Building production-ready assets

To transpile and bundle Sass and JS, and build the site:

npm run build

Testing

npm test