Skip to content
docs.pkgs.ml

Package docs

API reference for every package published on pkgs.ml, generated with riot doc and versioned per release.
Find a package How docs are built

Versioned by release

Each release has its own docs at /p/<package>/<version>/, so links keep pointing at the API you read.

Generated from source

Pages come from riot doc: modules, types, values, and functions, with their doc comments and signatures.

Find packages on pkgs.ml

Search, install counts, release history, and accounts live on pkgs.ml. Each package page links here.

Generate docs locally

Section titled “Generate docs locally”

Run riot doc in any Riot workspace to build the same pages for your own packages before you publish.

Terminal window
riot doc

See how docs are built for routes and the publishing pipeline.