elements / nuxt
AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub
This file only covers how this starter wires Elements into Nuxt. 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/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/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
10 rules. About 0 are common, 0 are distinctive, and 10 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
10
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 7
Keep vue.compilerOptions.isCustomElement in nuxt.config.ts so Vue treats nve-* tags as custom elements.
- Very specific: line 8
Keep global htmlAttrs for lang, nve-theme, and nve-transition in nuxt.config.ts.
- Very specific: line 9
Keep Elements Vue type references in env.d.ts.
- Very specific: line 10
Import global Elements CSS in app/app.vue.
- Very specific: line 15
Use NuxtLink inside Elements navigation components such as nve-tabs-item.
- Very specific: line 16
Keep route content in app/pages/* and shared shell in layouts.
- Very specific: line 20
Use Vue custom element syntax: :property for properties and @event for custom events.
- Very specific: line 21
Run nuxi typecheck through the package build before trusting template types.
- Very specific: line 25
Run pnpm run build in projects/starters/nuxt after config, layout, page, or type changes.
- Very specific: line 26
Run pnpm run lint after Vue, TypeScript, or config edits.
≈ “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 Nuxt Starter
This file only covers how this starter wires Elements into Nuxt. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.
Integration Points
- Keep
vue.compilerOptions.isCustomElementinnuxt.config.tsso Vue treatsnve-*tags as custom elements. - Keep global
htmlAttrsforlang,nve-theme, andnve-transitioninnuxt.config.ts. - Keep Elements Vue type references in
env.d.ts. - Import global Elements CSS in
app/app.vue.
Layouts And Pages
- Register Elements in the SFC that renders them. Shared page shell registrations belong in
app/layouts/default.vue. - Use
NuxtLinkinside Elements navigation components such asnve-tabs-item. - Keep route content in
app/pages/*and shared shell in layouts.
Vue Syntax
- Use Vue custom element syntax:
:propertyfor properties and@eventfor custom events. - Run
nuxi typecheckthrough the package build before trusting template types.
Verification
- Run
pnpm run buildinprojects/starters/nuxtafter config, layout, page, or type changes. - Run
pnpm run lintafter Vue, TypeScript, or config edits.
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.

