Skip to content

RAWRMediaLtd/groundwork

Repository files navigation

Groundwork

Created by Robert Forbes (@roboticdinosaur and is based on the work by Stephanie Eckles (@5t3ph) and Thanh Tran (@trongthanh) as well as some others.

Quick Start

  1. Generate a repo from this template which will copy this project into your own new repo.

  2. Once cloned, run npm install to install 11ty and other dependencies. Then run npm start to run both 11ty and sass in watch mode. Use npm run build to run a production version, which will also generate social share preview images.

  3. Open src/_data/*.json and adjust the values as required.

  4. Edit src/_includes/home.njk to change the home page - including changing the template type if desired - and then create content within src/pages using any templating format you prefer to add content.

  5. Review the 11ty documentation to more deeply apply customizations, including adding custom data sources and reviewing what template languages are available.

Is Netlify hosting required?

It's not required, but highly recommended, and is also how the build process is setup to run against.

Development Scripts

npm start

Run 11ty with hot reload at localhost:8080

npm run build

Production build includes minified, autoprefixed CSS and social preview image generation

Use this as the "Publish command" if needed by hosting such as Netlify.

Feedback welcome!

You can file it as an issue.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published