kacollins / thunderplains-2020

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Netlify Status

Skeleventy

A skeleton boilerplate built with Eleventy. Check out Skeleventy

Requirements

Node >= v8.9.0

Installation

npm install

cd into your project folder and npm run dev which will start the development server and Gulp. Eleventy has browser hot reloading baked in and will watch all files for changes.

For those of you on Windows, see Daniel Schildt's potential fix for the environment helper.

Folder Structure

The site folder contains all the templates, pages and content which Eleventy will watch and compile into HTML for us.

A globals folder lives within this, where as the name suggests - globally available files live. There's a site.json file for general site stuff (name, author, email etc), navigation.json which we use as reference to loop over in our template to generate our nav and a helpers.js which just contains an environment helper.

Uncompiled SCSS and JS reside in the resources folder - Gulp will be watching these folders for any changes (you should restart the server when creating new partials).

When in development mode, Skeleventy will use main.css as the stylesheet. This will be pretty chunky in filesize, due to it containing all of Tailwind's utility classes. Once you run the build command ready for deployment, Skeleventy will then reference the minified version of the stylesheet main.min.css.

Purge will also run via the build command and will cross reference all of Tailwind's utility classes with your templates/HTML and will remove all the unused ones - pretty cool right?

Ready to deploy?

npm run build to minify scripts and run Purgecss over your styles.

Feel free to adapt this as you wish! Go build some cool stuff and put it on Netlify - seriously it's the future! :)

About


Languages

Language:HTML 78.0%Language:JavaScript 20.2%Language:SCSS 1.7%