Jekyll Netlify Boilerplate screenshot

Jekyll Netlify Boilerplate

Author Avatar Theme by Danurbanowicz
Updated: 10 Jun 2020
70 Stars

A simple Jekyll template for creating a fast, static website on Netlify

Categories

Overview

The Jekyll Netlify Boilerplate is a simple template for creating fast, static websites on Netlify with a continuous deployment workflow. It features minimal styling, example blog posts, pages, and a contact form. The template also includes a responsive CSS Grid layout with fallbacks for older browsers. It utilizes Netlify CMS for content management, Netlify Identity for user authentication, and Netlify Forms for processing static HTML forms with reCAPTCHA. The template also includes optional Netlify _redirects and _headers files, as well as a Jekyll SASS pipeline for minified HTML and CSS. Overall, the Jekyll Netlify Boilerplate provides a streamlined and efficient setup for building and deploying websites on the Netlify platform.

Features

  • Minimal styling, ready to customize
  • Example blog posts, pages, and contact form
  • Responsive CSS Grid layout with fallbacks for older browsers
  • Continuous Deployment workflow via Netlify and Github
  • Netlify CMS for managing content
  • Netlify Identity for authenticating users
  • Netlify Forms for processing static HTML forms with reCAPTCHA
  • Optional Netlify _redirects and _headers files
  • Jekyll SASS pipeline for minified HTML and CSS

Installation

To use the Jekyll Netlify Boilerplate, follow these steps:

  1. Click the “Deploy to Netlify” button to deploy the repository to Netlify.
  2. After deployment, Netlify Identity will add you as a CMS user and email you an invite.
  3. If you wish to use an OAuth provider (e.g. Github) for authentication, setup the provider in Netlify app settings.
  4. Navigate to /admin on your site, choose your OAuth provider from the login box, and log into the CMS.
  5. You can now start editing content on your site.

For local development:

  1. Clone the repository.
  2. Run the command bundle install (or use Docker if you don’t want to install ruby-bundler).
  3. Jekyll will watch your project folder for changes.
  4. Preview the site at localhost:4000 and localhost:4000/admin.

Note: If you switch the repository to private, you’ll need to regenerate your token. Instructions for regenerating the token can be found in the Netlify site dashboard under “Settings” > “Identity” > “Services”.

Summary

The Jekyll Netlify Boilerplate is a straightforward template for creating fast, static websites on Netlify. It provides a range of features including minimal styling, example content, responsive layout, continuous deployment workflow, and various Netlify services for content management, user authentication, and form processing. The template also offers customization options and a smooth local development experience. Overall, the Jekyll Netlify Boilerplate is a valuable resource for developers looking to build and deploy websites on the Netlify platform.