Skip to content

GameRoMan/api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lichess API Docs & Examples

Run locally

cd doc
pnpm install
pnpm dev

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

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

About

Lichess API documentation and examples

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 91.5%
  • JavaScript 7.7%
  • HTML 0.8%