NPM should be installed on your machine.
- Install:
npm install - Run:
npx @11ty/eleventy --serve
This project incorporates a few features. More details about each feature are described later in this file. These features are:
The 404 Page is implemented using a variant of Eleventy’s Offical 404 Instructions.
The 404 content is in a markdown file, 404.md. The layout is 404.njk in case we want extra flexibility. It’s excluded from the site’s navigation using eleventyExcludeFromCollections: true. Remove that frontmatter data if you want it in the navigation.
Using the official Eleventy Navigation Plugin we can implement complex information architecture. To illustrate its use, sample content in /parent with children has been added. Feel free to change this as necessary. Consult the Eleventy docs for using things such as order and parent.
Human readable sitemaps help comply with WCAG Success Criteria 2.4.5 Multiple Ways. The content file is named human-sitemap.md with a matching layout of human-sitemap.njk.
This project already has built-in support for an XML Sitemap, used for search engine indexing. This file sitemap-seo.njk is the only place it exists. Like the 404 file, it’s excluded from the site navigation.
Social media previews are put in this project using the Open Graph meta elements. These previes are enabled with various front matter data, such as excerpt and social-image.
Favicons are already saved in the project so you can replace them with your own. Just use the sizes, filenames as they are. Be sure to set the themeColor in the <head> in the /_data/site.json file.