5t3ph / 11ty-netlify-jumpstart

Quickly launch an 11ty-generated static site. Includes a minimal Sass framework, and generated sitemap, RSS feed, and social share preview images.

Home Page:https://11ty-netlify-jumpstart.netlify.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

11ty Netlify Jumpstart

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.

Quick Start

  1. 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.

  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/meta.js and adjust the values to your details.

  4. Review the styling documentation for the included minimal Sass framework, particularly the theme variables, to quickly customize the starter.

  5. 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.

  6. Check out the About page for expanded details on included features of this starter.

  7. 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.

Buy me a coffee

ezoic increase your site revenue

About

Quickly launch an 11ty-generated static site. Includes a minimal Sass framework, and generated sitemap, RSS feed, and social share preview images.

https://11ty-netlify-jumpstart.netlify.app

License:ISC License


Languages

Language:SCSS 52.3%Language:Nunjucks 40.9%Language:JavaScript 6.8%