Skip to content

usecustard/parresia.ca

Repository files navigation

layout default
image og-image.jpg
title Parresia.ca
excerpt A hackable Jekyll template based on the HTML5 boilerplate with beautiful typography

Parresia.ca

Netlify Status

This project is a frankenstein of the HTML5 boilerplate and Matej Latin's Gutenberg typography kit, adapted for jekyll by JerTurowetz.

You can find the project repo here.

The HTML5 boilerplate server config, build, test and deploy tools have been removed and the implemented version of Gutenberg has been zealously shaved down, making it easy to jump right in to, replaced by the original Gutenberg or dumped in lieu of your own preferred styles.

Features

  • /vscode/settings.json ready to go
  • .editorconfig defaults for winners
  • super sweet Makefile for Netlify deploys (including branch deploys)

Requirements

  • Ruby 3.3.0 (managed via rbenv)
  • Bundler
  • Node.js (for Netlify CLI)
  • ImageMagick (for responsive images)

Getting started

Installation

# Install ImageMagick (if not already installed)
brew install imagemagick

# Install Ruby dependencies
bundle install

# Install Node dependencies (for Netlify CLI)
npm install

Development

Standard Jekyll server:

npm run dev
# or
bundle exec jekyll serve

Site at http://localhost:4000

Netlify dev server (with redirects):

npm run dev:netlify
# or
netlify dev

Site at http://localhost:8888

Build

npm run build
# or
bundle exec jekyll build

Deployment

Production:

npm run deploy

Preview:

npm run deploy:preview

Placeholder files you should definitely edit

  • _config.yml
  • src/favicon.ico
  • src/icon.png
  • src/tile-wide.png
  • src/tile.png
  • src/index.md

Editing the sass

src/base/_normalize.scss & src/base/main.scss are imports from the html5 boilerplate. The src/_sass/mixins/ & src/_sass/typography/ folders are my trimmed version of Matej Latin's Gutenberg.

The rest is just basic layout stuff that you can hack up however you want. I usually like to set some variables like colors & type, then set up basic layou in src/_sass/layout/, then make a new folder called src/_sass/theme/ and do whatever.

To do

  • Exclude CSS & JS from jekyll and manage with webpack instead
  • compress & resize images with whatever used above
  • Add basic htaccess/nginx header rules for simple setups

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors