# AGENTS.md

The world’s fastest framework for building websites.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `tpl/`       212 source files
- `resources/` 152 source files
- `hugolib/`   122 source files
- `common/`    109 source files
- `markup/`    58 source files
- `internal/`  32 source files

## Conventions

- Tests live alongside the code they cover, following `bufferpool/bufpool_test.go`.
- CI defines what passing means. See `.github/workflows/image.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `internal/warpc/js/renderkatex.bundle.js` is 299KB. 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.