agentleFS
NVIDIAKnown publisherNVIDIA/elements/projects/starters/go-htmx/AGENTS.md

elements / go-htmx

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

This file only covers how this starter wires Elements into Go templates and HTMX fragment responses. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

14 rules. About 0 are common, 8 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    Keep HTMX swap content in fragment templates under src/.

    line 9
  2. Distinctive:

    Keep dynamic values in Go data structs and pass them into templates.

    line 10
  3. Distinctive:

    Use static bundles or a separate frontend build pipeline.

    line 11
  4. Distinctive:

    Use pre-built browser-loadable bundles when keeping the starter free of frontend build tooling.

    line 15
  5. Very specific:

    If serving local bundles instead, add explicit static file handling in main.go and point CSS and module imports at that route.

    line 16
  6. Distinctive:

    Keep theme attributes on the root HTML template, not in Go handler code.

    line 17
  7. Distinctive:

    Use escaped template output for data values.

    line 21
  8. Very specific:

    Only use trusted template HTML for checked Elements markup and HTMX attributes.

    line 22
  9. Distinctive:

    Keep routing and rendering small.

    line 23
  10. Very specific:

    Keep fragment endpoints under /fragment/.

    line 27
  11. Distinctive:

    Keep full-page templates and fragment templates separate so fragment routes do not render the page shell.

    line 29
  12. Distinctive:

    Keep HTMX request behavior in templates, not generated handler strings.

    line 30
  13. Very specific:

    Run pnpm run build in projects/starters/go-htmx after Go or template changes.

    line 34
  14. Very specific:

    Run pnpm run dev for local rendering checks on http://localhost:8080.

    line 35

≈ “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 HTMX + Go Starter

This file only covers how this starter wires Elements into Go templates and HTMX fragment responses. For component APIs, template validation, and project setup commands, use the Elements CLI/MCP documentation instead.

Integration Points

  • Render Elements markup through html/template in src/index.html.
  • Render the full page through the root route.
  • Keep HTMX swap content in fragment templates under src/.
  • Keep dynamic values in Go data structs and pass them into templates; do not concatenate HTML strings in handlers.
  • Use static bundles or a separate frontend build pipeline. This starter is the static-bundle path.

Static Assets

  • Use pre-built browser-loadable bundles when keeping the starter free of frontend build tooling.
  • If serving local bundles instead, add explicit static file handling in main.go and point CSS and module imports at that route.
  • Keep theme attributes on the root HTML template, not in Go handler code.

Go Template Constraints

  • Use escaped template output for data values.
  • Only use trusted template HTML for checked Elements markup and HTMX attributes.
  • Keep routing and rendering small; move repeated page shell or fragment code into templates before adding more routes.

HTMX Constraints

  • Keep fragment endpoints under /fragment/.
  • Return only the target fragment from fragment routes.
  • Keep full-page templates and fragment templates separate so fragment routes do not render the page shell.
  • Keep HTMX request behavior in templates, not generated handler strings.

Verification

  • Run pnpm run build in projects/starters/go-htmx after Go or template changes.
  • Run pnpm run dev for local rendering checks on http://localhost:8080.

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.