agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/elements/projects/starters/hugo/AGENTS.md

elements / hugo

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

This file only covers how this starter wires Elements into Hugo. 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 static bundle CSS and module script loading in layouts/baseof.html.

    line 8
  2. Very specific:

    Keep the Elements page shell in layouts/baseof.html and page-specific content in blocks or partials.

    line 10
  3. Very specific:

    Use Hugo render hooks to map markdown features onto Elements:

    line 14
  4. Very specific:

    Keep local and hosted base URL handling in baseof.html.

    line 23
  5. Distinctive:

    Use relative links in tabs and partials so static output works under the hosted starter path.

    line 24
  6. Very specific:

    Run pnpm run build in projects/starters/hugo after config, template, or render-hook changes.

    line 28

≈ “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 Hugo Starter

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

Integration Points

  • Mount Elements package dist folders in hugo.toml before referencing package assets from templates.
  • Keep static bundle CSS and module script loading in layouts/baseof.html.
  • Allow raw HTML through Goldmark only when content authors are trusted to write checked Elements markup.
  • Keep the Elements page shell in layouts/baseof.html and page-specific content in blocks or partials.

Render Hooks

  • Use Hugo render hooks to map markdown features onto Elements:
    • headings: add nve-text based on heading level.
    • links: add nve-text="link" and external-link attributes.
    • tables: render nve-grid, nve-grid-header, nve-grid-row, and cells.
    • code blocks: render nve-codeblock.
  • Register the package bundle for any component introduced by a render hook.

Base URLs

  • Keep local and hosted base URL handling in baseof.html.
  • Use relative links in tabs and partials so static output works under the hosted starter path.

Verification

  • Run pnpm run build in projects/starters/hugo after config, template, or render-hook 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.

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.

Check your setup, free