elements / eleventy
AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub
This file only covers how this starter wires Elements into Eleventy. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository46 other files it gives its agents.
- AGENTS.mdAGENTS.md
- projects/starters/angular/AGENTS.mdAGENTS.md
- projects/starters/bundles/AGENTS.mdAGENTS.md
- projects/starters/eleventy-ssr/AGENTS.mdAGENTS.md
- projects/starters/go/AGENTS.mdAGENTS.md
- projects/starters/go-htmx/AGENTS.mdAGENTS.md
- projects/starters/hugo/AGENTS.mdAGENTS.md
- projects/starters/importmaps/AGENTS.mdAGENTS.md
- projects/starters/lit-library/AGENTS.mdAGENTS.md
- projects/starters/mcp-app/AGENTS.mdAGENTS.md
- projects/starters/mpa/AGENTS.mdAGENTS.md
- projects/starters/nextjs/AGENTS.mdAGENTS.md
- projects/starters/nuxt/AGENTS.mdAGENTS.md
- projects/starters/react/AGENTS.mdAGENTS.md
- projects/starters/solidjs/AGENTS.mdAGENTS.md
- projects/starters/sphinx/AGENTS.mdAGENTS.md
- projects/starters/svelte/AGENTS.mdAGENTS.md
- projects/starters/typescript/AGENTS.mdAGENTS.md
- projects/starters/vue/AGENTS.mdAGENTS.md
- agent-availability-reportSkill
- agent-debug-ciSkill
- agent-dependenciesSkill
- agent-startersSkill
- agent-upkeepSkill
- agent-web-modernizationSkill
- audit-accessibilitySkill
- audit-ciSkill
- audit-codeSkill
- audit-consolidationSkill
- audit-simplificationSkill
- authoring-benchmarksSkill
- authoring-componentsSkill
- authoring-documentationSkill
- authoring-examplesSkill
- authoring-patternsSkill
- authoring-projectsSkill
- authoring-testsSkill
- authoring-typescriptSkill
- elementsSkill
- github-dependabotSkill
- guidance-api-designSkill
- guidance-buildSkill
- guidance-webgpu-performanceSkill
- summarize-releasesSkill
- summarize-video-releasesSkill
- troubleshootingSkill
The file
We split this AGENTS.md into the rules it gives an agent
9 rules. About 0 are common, 2 are distinctive, and 7 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 7
Keep global Elements CSS in src/_layouts/index.css.
- Very specific: line 9
Keep shared page shell markup in src/_layouts/index.11ty.js.
- Very specific: line 10
Use @11ty/eleventy-plugin-vite for bundling the layout entrypoint.
- Very specific: line 14
Add nve-text and nve-layout attributes through the markdown-it renderer in eleventy.config.js when markdown should receive Elements …
- Distinctive: line 15
Keep renderer mappings constrained to token types that markdown-it exposes predictably: headings, paragraphs, links, and lists.
- Very specific: line 20
Keep the <base> URL and Vite base aligned with PAGES_BASE_URL.
- Distinctive: line 21
Use relative links in generated tab markup so static output works under the starter base path.
- Very specific: line 25
Run pnpm run build in projects/starters/eleventy after layout, renderer, or asset pipeline changes.
- Very specific: line 26
Run pnpm run lint when editing Eleventy config or layout TypeScript.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Elements Eleventy Starter
This file only covers how this starter wires Elements into Eleventy. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.
Integration Points
- Keep global Elements CSS in
src/_layouts/index.css. - Register Elements used by layout or markdown content in
src/_layouts/index.ts. - Keep shared page shell markup in
src/_layouts/index.11ty.js; page files should supply content. - Use
@11ty/eleventy-plugin-vitefor bundling the layout entrypoint.
Markdown Rendering
- Add
nve-textandnve-layoutattributes through the markdown-it renderer ineleventy.config.jswhen markdown should receive Elements typography. - Keep renderer mappings constrained to token types that markdown-it exposes predictably: headings, paragraphs, links, and lists.
- Let raw
nve-*HTML pass through markdown only when the page intentionally owns that markup.
Routing
- Keep the
<base>URL and Vitebasealigned withPAGES_BASE_URL. - Use relative links in generated tab markup so static output works under the starter base path.
Verification
- Run
pnpm run buildinprojects/starters/eleventyafter layout, renderer, or asset pipeline changes. - Run
pnpm run lintwhen editing Eleventy config or layout TypeScript.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

