# AGENTS.md

A markdown parser and compiler. Built for speed.

## Setup

```
npm ci
```

## Commands

```
npm run build           # produce a build
npm run test            # run the test suite, must pass before any commit
npm run lint            # lint
npm run bench
npm run build:docs
npm run build:esbuild
npm run build:man
npm run build:reset
```

## Layout

- `test/` 38 source files
- `src/`  13 source files
- `docs/` 4 source files
- `bin/`  2 source files
- `api/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `test/.eslintrc.json`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/tests.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.