Created by Stephanie Eckles (@5t3ph)
Visit 11ty-netlify-jumpstart.netlify.app for all the feature details - or go ahead and generate a new repo from the template to view the information locally.
-
Generate a repo from this template which will copy this project into your own new repo if you are currently signed in to GitHub. Alternatively, visit the repo directly.
-
Once cloned, run
npm install
to install 11ty and other dependencies. Then runnpm start
to run 11ty in watch mode. Usenpm run build
to run a production version. -
Open
src/_data/meta.js
and adjust the values to your details. -
Review the styling documentation for the included minimal Sass framework, particularly the theme variables, to quickly customize the starter.
-
Edit
src/index.njk
to change the home page - including changing the template type if desired - and then create content within_pages
using any templating format you prefer to add content. -
Check out the About page for expanded details on included features of this starter.
-
Review the 11ty documentation to more deeply apply customizations, including adding custom data sources and reviewing what template languages are available.
It's not required, but highly recommended, and is also how the build process is setup to run.
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.
You can file it as an issue.
For those that have use this starter before, you should know the following changes:
- removal of social media images - due to issues with packages for creating the images
- removal of stylelint
- update to use @11tyrocks/eleventy-plugin-sass-lightningcss for Sass processing