agentleFS
NVIDIAKnown publisherNVIDIA/elements/projects/starters/nuxt/AGENTS.md

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.

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
  1. Very specific:

    Keep vue.compilerOptions.isCustomElement in nuxt.config.ts so Vue treats nve-* tags as custom elements.

    line 7
  2. Very specific:

    Keep global htmlAttrs for lang, nve-theme, and nve-transition in nuxt.config.ts.

    line 8
  3. Very specific:

    Keep Elements Vue type references in env.d.ts.

    line 9
  4. Very specific:

    Import global Elements CSS in app/app.vue.

    line 10
  5. Very specific:

    Use NuxtLink inside Elements navigation components such as nve-tabs-item.

    line 15
  6. Very specific:

    Keep route content in app/pages/* and shared shell in layouts.

    line 16
  7. Very specific:

    Use Vue custom element syntax: :property for properties and @event for custom events.

    line 20
  8. Very specific:

    Run nuxi typecheck through the package build before trusting template types.

    line 21
  9. Very specific:

    Run pnpm run build in projects/starters/nuxt after config, layout, page, or type changes.

    line 25
  10. Very specific:

    Run pnpm run lint after Vue, TypeScript, or config edits.

    line 26

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

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.isCustomElement in nuxt.config.ts so Vue treats nve-* tags as custom elements.
  • Keep global htmlAttrs for lang, nve-theme, and nve-transition in nuxt.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 NuxtLink inside Elements navigation components such as nve-tabs-item.
  • Keep route content in app/pages/* and shared shell in layouts.

Vue Syntax

  • Use Vue custom element syntax: :property for properties and @event for custom events.
  • Run nuxi typecheck through the package build before trusting template types.

Verification

  • Run pnpm run build in projects/starters/nuxt after config, layout, page, or type changes.
  • Run pnpm run lint after Vue, TypeScript, or config edits.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.