agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/elements/projects/starters/eleventy-ssr/AGENTS.md

elements / eleventy-ssr

AGENTS.md115 starsChanged 54 days agoApache-2.0View on GitHub

This file only covers how this starter wires Elements into Eleventy with Lit SSR. 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

6 rules. About 0 are common, 1 is distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Keep mode: 'worker' for SSR isolation unless the build requirement changes.

    line 8
  2. Very specific:

    Use metadata to generate broad component entrypoint lists only for SSR demos that intentionally exercise many Elements.

    line 10
  3. Very specific:

    Import @lit-labs/ssr-client/lit-element-hydrate-support.js in the client module script before importing client-side define.js modules.

    line 14
  4. Distinctive:

    Keep raw generated examples filtered away from components that are not SSR-safe for this starter.

    line 19
  5. Very specific:

    If transforming example templates, keep the transforms local and explicit in src/index.11ty.js.

    line 20
  6. Very specific:

    Run pnpm run build in projects/starters/eleventy-ssr after SSR config, metadata filtering, or template changes.

    line 24

≈ “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 Eleventy SSR Starter

This file only covers how this starter wires Elements into Eleventy with Lit SSR. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

Integration Points

  • Configure Lit SSR in eleventy.config.js through @lit-labs/eleventy-plugin-lit.
  • Keep mode: 'worker' for SSR isolation unless the build requirement changes.
  • Provide server-renderable Elements through componentModules; include @nvidia-elements/core/dist/icon/server.js before component define.js entrypoints when icons can render server-side.
  • Use metadata to generate broad component entrypoint lists only for SSR demos that intentionally exercise many Elements.

Hydration

  • Import @lit-labs/ssr-client/lit-element-hydrate-support.js in the client module script before importing client-side define.js modules.
  • Match server componentModules and client define.js imports for components rendered in the HTML.

Template Constraints

  • Keep raw generated examples filtered away from components that are not SSR-safe for this starter.
  • If transforming example templates, keep the transforms local and explicit in src/index.11ty.js.

Verification

  • Run pnpm run build in projects/starters/eleventy-ssr after SSR config, metadata filtering, or template changes.

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.

Reviews can't be read right now.

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.

Check your setup, free