Get Going is an 11ty starter project for simple blogs, small sites and prototypes.
Now upgraded to use ES6 modules and 11ty v3.0 🎉
The following starting points and integrations come included:
- 11ty Pagination
- 11ty Navigation
- 11ty Image
- 11ty RSS
- 11ty Syntax Highlighting
- Eleventy Plugin: Lightning CSS
- Markdown-it
- Markdown-it Footnote
- Markdown-it Definition Lists
- Markdown-it Sub
- Markdown-it Sup
- Markdown-it-eleventy-img
Node version manager is recommended then simply nvm use and it will pull the version from the .nvmrc file in this repo. Any Node LTS version should suffice for this template.
To run a version yourself, clone the repo, npm install and then npm run serve to view the demo project locally.
If you're intending to use Git LFS remember to git lfs install to enable it.
There's a little bit of housekeeping to do in order to make this template your own.
This project uses a single file to capture project-wide metadata, basically to populate all the stuff in a <head> tag on your pages. This can be found under src/data/config.js. These of course can be overridden in your content frontmatter thanks to Eleventys data cascade.
// Required. The name of your project.
projectName: "11ty Get Going",
// Required. A brief description of your project.
description: "Just another 11ty starter kit",
// Required. A short name used exclusively in webmanifest.njk. Keep it under 12 characters to minimize the possibility of truncation. Can be safely deleted if you delete webmanifest.njk.
shortName: "11ty GG",
// Required. Update development and production urls to your project requirements.
domain: process.env.ELEVENTY_RUN_MODE == "serve" ? "http://localhost:8080" : "https://example.com",
// Required. SEO indexing behaviour.
robots: "index, follow",
// Required. Used exclusively in webmanifest.njk. This sometimes affects how an OS displays your site. Can be safely deleted if you delete webmanifest.njk.
themeColor: "#FFFFFF",
// Required. Used exclusively in webmanifest.njk. Recommend using the same value as body background color in your CSS. Can be safely deleted if you delete webmanifest.njk.
backgroundColor: "#FFFFFF",
// Optional. Delete block if not used. Author values for project.
author: {
name: "Author Name",
email: "[email protected]",
},
// Optional. Delete block if you don't require link tags related to your idenity. Duplicate as many objects as you need!
identity: [
{
rel: "me",
url: "URL-GOES-HERE",
},
],
// Optional. Delete block if you don't require Opengraph.
og: {
locale: "en_GB",
type: "website",
image: {
rel: "/og-default.jpg",
alt: "Default OG image displayed here",
},
}Favicons are stored under src/static/favicons and are automatically passed through to their relevant directories on build. All you need to do is create the images for your project.
A default Opengraph image can be found under src/static and is named og-default.jpg. Much like the favicons all you need to do is create a relevant default image to be used.
If you decide to delete this file (for example if you don't require Opengraph in your project), then you must update eleventy.config.js and remove this line:
eleventyConfig.addPassthroughCopy({ "src/static/og-default.jpg": "/og-default.jpg" });By default this template collects all posts under src/content/posts to populate the RSS feed. You would most likely want something different for your project. If you visit etc/collections/index.js and edit the following to fit your needs:
export const feed = i => i.getFilteredByGlob("./src/content/posts/*.md").reverse();Images are stored in their original format under src/media, although you can organise images in any way in this project.
This project adheres to Markdown syntax as much as possible and uses Markdown-it-eleventy-img in order to leverage the magic of Eleventy Image to generate responsive images based on your needs (so you can do something like this  and get all the responsive benefits without much effort).
For images imported using Markdown syntax, this project wraps images in a <figure> by default and a <figcaption> is rendered if a title attribute is applied to your image (e.g. ).
Finally, if a gif is imported it is assumed this is animated, so relevant logic is set to make that possible.
You will most likely want to adapt widths, sizes and formats to suit your projects needs. You will want to edit the Markdown-it library located in lib/markdown.js and find these object keys:
const eleventyImageOptions = {
imgOptions: {
widths: [300, 600, 1200, 1800, 2150],
urlPath: "/img/",
outputDir: "./dist/img/",
formats: ["avif", "jpeg"],
},
globalAttributes: {
decoding: "async",
loading: "lazy",
sizes: "(max-width: 72rem) 100vw, 75vw",
},
...
..
.With that all said and done you should be ready to get on with your project. Good going!