jessesquires / template-jekyll-site

Template repository for Jekyll websites

template-jekyll-site

Template repository for Jekyll websites

About

This repo contains default project files for Jekyll-based website projects.

Setup

This setup mostly assumes that you are building a site with Jekyll on NearlyFreeSpeech.net, but can be easily adapted for other hosts.

Requirements

• Bundler
• NPM

Dependencies

Gems

• jekyll (Latest) (Cheat Sheet)
• jekyll-sitemap
• jekyll-paginate or jekyll-paginate-v2

Updating Gems

$ make update-bundle

NPM packages

• Bootstrap (package)
• Bootstrap Icons (package)

Updating packages

$ make update-deps

Usage

Installation

$ git clone https://github.com/jessesquires/template-jekyll-site
$ cd template-jekyll-site/
$ make install

Building the site

$ make

Previewing the site locally

$ make preview

Validation

Feeds

• https://validator.w3.org/feed/
• https://json-feed-validator.herokuapp.com

Markup

• https://validator.w3.org/nu/

Structured Data

• https://cards-dev.twitter.com/validator
• https://www.opengraphcheck.com
• https://search.google.com/structured-data/testing-tool

License

This work is released under the CC0 1.0 Universal (CC0 1.0) license. See LICENSE.

All code is licensed under an MIT License.