Skip to content

tools/apidocs

import "github.com/nuqs-org/nuqs/tools/apidocs"

Command apidocs writes the API reference pages of the website, one page per package, from the doc comments in the code.

Each type and function gets its own heading, so the website's sidebar works as a clickable index. Run it from the repo root:

go run ./tools/apidocs        # writes docs/api/

Note

This is a program, not a library, so it has no API to list.