mermaid-js/mermaid

At a glance

Rank

#87 of 401

Top 22% · #23 of 82 TypeScript repos

Checks passed

10 of 17

Full list below

Best set up for

Claude Code

Score 83.6

Needs most work for

Cursor

Biggest fix: Cursor rules (.cursor/rules) (+11.5 pts)

What to fix first

Showing fixes for Claude Code

1. 1
   AGENTS.md / CLAUDE.md

   Add an AGENTS.md covering project goals, layout, setup commands, and conventions. Aim for 800+ chars of real guidance (not boilerplate).
   +13.2 pts
2. 2
   Manageable size

   If possible, split into smaller modules or carve out a focused entry path. Document where to start in AGENTS.md.
   +3.3 pts

Score for each AI agent

Each agent weighs the checks by its own docs. Under each score are its top three. How each agent is scored →

Does mermaid-js/mermaid have agent instructions?

An AGENTS.md (or CLAUDE.md) at the root tells AI coding agents how to build, test and work in the repo. A few agents also read a file of their own.

AGENTS.md / CLAUDE.md

✗None at the root (no AGENTS.md, CLAUDE.md, AGENT.md, .claude/CLAUDE.md or .claude/AGENTS.md)

Agent-specific files

None: no GEMINI.md, .cursor/rules, .openhands/setup.sh, .aider.conf.yml or .agents/skills

Repos that have one

62 of 82 TypeScript repos · 221 of 401 repos on the leaderboard · See examples →

# AGENTS.md

Guidance for AI coding agents working in mermaid-js/mermaid. Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown. Written mainly in TypeScript.

## Where things are

- Dependencies are declared in `package.json`.
- Tests live in `tests`.
- Lint and format rules are configured in `eslint.config.js`.
- Type checking is configured in `tsconfig.json`.
- CI is defined in `.github/workflows`; read it for the exact install, lint and test steps.
- Commit hooks are set up in `.husky`; don't skip them.
- A reproducible environment is defined in `Dockerfile`.
- Follow the conventions in `CONTRIBUTING.md`.

## Commands

<!-- Fill in the exact commands CI runs. -->
- Install: TODO
- Test: TODO
- Lint: TODO

How mermaid-js/mermaid compares

vs leaderboard average

11.5 pts above

Average 66.8

vs TypeScript average

7.1 pts above

Average 71.2

Stars among TypeScript repos

#18 of 82

One fix for the most agents: AGENTS.md / CLAUDE.md would raise the score for all 9 agents, by up to 13.3 points.

Similar repos

Same language and host as this repo, closest in overall score.

• microsoft/playwright79.1
  TypeScript · 99.3k ★
• modelcontextprotocol/servers78.9
  TypeScript · 91.8k ★
• withastro/astro78.6
  TypeScript · 63.7k ★
• TanStack/router78.6
  TypeScript · 15.3k ★
• payloadcms/payload78.3
  TypeScript · 45.7k ★
• calcom/cal.diy77.9
  TypeScript · 49.7k ★

Same topics, any language

Repos tagged with the same GitHub topics, most shared first.

• excalidraw/excalidraw84.3
  TypeScript · diagrams
• storybookjs/storybook67.8
  TypeScript · documentation
• mkdocs/mkdocs56.4
  Python · documentation