# AGENTS.md

The HTML Presentation Framework

## Setup

```
npm ci
```

## Commands

```
npm run dev            # run locally
npm run start          # run the app
npm run build          # produce a build
npm run test           # run the test suite, must pass before any commit
npm run prepack
npm run build:core
npm run build:es5
npm run build:styles
```

## Layout

- `js/`      29 source files
- `dist/`    27 source files
- `plugin/`  23 source files
- `react/`   23 source files
- `scripts/` 5 source files
- `test/`    5 source files

## Conventions

- Tests live alongside the code they cover, following `react/src/__tests__/setup.ts`.
- 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/spellcheck.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `dist/plugin/highlight.mjs` is 1017KB. It will not fit comfortably in context, so read it in parts.

---

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.