agentleFS
Sign inStart free
thenavidmthenavidm/design-md-generator/AGENTS.md

design-md-generator

AGENTS.md0 starsChanged 47 days agoMITView on GitHub

For agents editing this repository. Users read the README. The library behind the free DESIGN.md generator at navid.me/free-tools/design-md-generator. Published on npm as @thenavidm/design-md-generator. A CLI and an MCP server over the same functions come later, in this repo. Commit with the machine's global git identity. Never pass -c user.email=. The global config is correct and the override is the bug. No AI attribution in commits. The format is Google's, read from its source on the day of a change. github.com/google-labs-code/design.md,…

  • 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 repositoryOne other file it gives its agents.

The file

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

1 rule. About 0 are common, 0 are distinctive, and 1 is 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.

  • 1

    Very specific

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

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

    Commit with the machine's global git identity: Never pass -c user.email=.

    line 22

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

Working on design-md-generator

For agents editing this repository. Users read the README.

The library behind the free DESIGN.md generator at navid.me/free-tools/design-md-generator. Published on npm as @thenavidm/design-md-generator. A CLI and an MCP server over the same functions come later, in this repo.

Layout

src/sections.ts  the format: the 8 sections in order, the front matter keys, the types
src/color.ts     any CSS color to sRGB, WCAG contrast (never rounded)
src/write.ts     a DesignSystem as a DESIGN.md
src/parse.ts     a DESIGN.md back into a DesignSystem
src/lint.ts      Google's checks and ours, as codes
src/import.ts    tokens from CSS variables, a Tailwind config, token JSON or a list
src/export.ts    Tailwind v4 CSS and design tokens JSON
tests/           vitest; official.test.ts runs Google's linter on the same files

Non-negotiables

Commit with the machine's global git identity. Never pass -c user.email=. The global config is correct and the override is the bug.

No AI attribution in commits.

The format is Google's, read from its source on the day of a change. github.com/google-labs-code/design.md, docs/spec.md. Where a rule shares a name with Google's linter, it matches Google's conditions exactly, info notes included; tests/official.test.ts fails the moment they drift. Read Google's dist/linter/index.js, not only the spec: the spec's words and the linter's code differ in places (omitted is token groups; missing-sections is spacing and corners). Update @google/design.md and rerun the tests when Google ships a new version.

Results are data and codes, never sentences. The screen that shows them owns the words, so every language can have them through navid.me's CMS.

Imports never run code. A Tailwind config is read as text.

Releasing

Bump the version, add the CHANGELOG entry, run npm test, then npm publish --dry-run and read the file list: only dist, README.md, LICENSE and package.json. Then npm publish --access public. navid.me and the plugins that use it update by version, never from a packed copy.

GitHub sidebar

Description (same words as the README's first line and package.json). Topics: .github/topics. Website: https://navid.me/free-tools/design-md-generator.

Public

The repo is public. Every push is seen at once: audit before pushing anything a reader sees (README, the standard files, examples), and never commit a key, a path on your machine or an email address.

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