Thanks to visit codestin.com
Credit goes to github.com

Skip to content

lichess-org/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Lichess API doc & examples

Run locally

cd doc
pnpm install
pnpm serve

Now open http://localhost:8089/. You should see the generated API doc.

Make modifications to doc/specs/lichess-api.yaml, and reload the page to see your changes.

Check the yaml files for syntax errors:

pnpm spectral
pnpm 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

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published