Shared Eleventy templates and includes used across ScanGov sites.
Copy templates to each site's content/ directory. Copy _includes/ files to each site's _includes/ directory.
All templates require layout: false in front matter to prevent directory-level layout defaults from wrapping non-HTML output.
Outputs /robots.txt. Allows all crawlers and references the sitemap.
Requires in site.json:
url— site base URL
Outputs /.well-known/security.txt (canonical) and /security.txt (convenience copy). Standard security disclosure file per securitytxt.org. Both files serve identical content; the Canonical field in both points to /.well-known/security.txt. Two files are required because GitHub Pages is static and cannot redirect between paths.
Requires in site.json:
url— site base URLorg-url— organization URL (used for Contact and Policy fields)securityExpires— ISO 8601 expiry date (e.g.2027-01-01T00:00:00.000Z)
Outputs /sitemap.xml. Includes all Eleventy collection pages except those with sitemap: false in front matter. Uses modified date when available, falls back to date.
Requires in site.json:
url— site base URL
Pagination and addAllPagesToCollections: sitemap.xml (and anything else that loops collections.all — search, a site index, RSS) only sees pages that are actually in collections.all. Eleventy's pagination feature only adds the first generated page to collections.all by default — any per-item pagination block (one page per person, domain, topic, dataset, etc., with its own permalink: referencing the pagination alias) must set addAllPagesToCollections: true, or every page after the first silently disappears from the sitemap with no build error. Reference example: orgs/index.html or profile/overview.html in the scangov repo. If pages are meant to stay out of collections on purpose, say so explicitly instead of just omitting the flag — addAllPagesToCollections: false (opts a per-item pagination page out specifically) or eleventyExcludeFromCollections: true (excludes a template from every collection outright, e.g. redirects.njk) — so a missing flag always reads as "forgotten," never "ambiguous." Each of the 5 deployed Eleventy sites also runs scripts/check-sitemap-completeness.js in CI to catch a forgotten flag automatically.
| File | Description |
|---|---|
analytics.html |
Google Analytics script (requires site.gaId) |
favicon.html |
Favicon link tags |
footer.html |
Site footer |
header.html |
Site <head> with meta, OG, schema |
jumbotron.html |
Page hero/banner |
jumbotron-default.html |
Default page hero |
nav.html |
Site navigation |
related.html |
Related content links |
search.html |
Search UI |
sidenav.html |
Sidebar navigation |
style.html |
CSS link tags |
js.html |
JS script tags |
toc.html |
Table of contents |
toc-mobile.html |
Mobile table of contents |
actions.html |
Action buttons |
audio.html |
Audio player |
connect.html |
Social/connect links |
details.html |
Expandable details |
feedback.html |
Feedback form |
filter-pill.html |
Filter pill UI |
image.html |
Responsive image |
post-badges.html |
Post metadata badges |
post-links.html |
Post navigation links |
scangov.html |
ScanGov branding |
schema-docs.html |
JSON-LD schema for docs pages |
404.html |
404 error page |