# AGENTS.md

fullPage plugin by Alvaro Trigo. Create full screen pages fast and simple

## Setup

```
npm install
```

## Commands

```
npm run dev          # run locally
npm run build        # produce a build
npm run test         # run the test suite, must pass before any commit
npm run extensions
npm run limited
npm run devtest
```

## Layout

- `src/`      98 source files
- `tests/`    37 source files
- `examples/` 6 source files
- `dist/`     1 source file
- `gulp/`     1 source file
- `types/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/index.html`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `dist/fullpage.js` is 199KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.