Lichess API Docs & Examples

• Example code
• Which authentication is right for me

Run locally

cd doc
pnpm install
pnpm dev

or with devenv

devenv up

Then open the URL printed in the terminal (usually http://localhost:5173).

Make modifications to any of the schema yaml files, and the page will rebuild and reload automatically.

Check the yaml files for syntax errors:

pnpm spectral
pnpm lint
pnpm scalar-lint

or with devenv

devenv tasks run api:check

Format the yaml files

pnpm format

Publish (for maintainers)

The docs + npm package will be published automatically each day if there are changes, but if you want to publish changes immediately, you can trigger the publish workflow.

Option 1: In the Github UI, manually dispatch the publish workflow

Option 2: From the command line:

gh workflow run publish