Command Palette
Search for a command to run...

Environment variables

Every variable is read at build time. In Docker, set them with -e on docker run; from source, set them in your shell or a .env file.

Site chrome

VariableDefaultEffect
PUBLIC_BRAND_NAMEopen-docsBrand text in the top bar.
PUBLIC_BRAND_TAGLINEdocsSubtitle next to the brand. Empty hides it.
PUBLIC_LOGO_SRC/favicon.svgLogo path under static/.
PUBLIC_SITE_TITLEopen-docsBrowser title and og:title.
PUBLIC_SITE_DESCRIPTIONgeneric blurbMeta and og:description.
PUBLIC_REPO_URL(empty)Shows a GitHub link in nav + footer when set.

The mobile browser theme-color (the chrome tint) isn't set here — it follows your --primary token automatically, in both light and dark mode. See Theming.

Content tokens

VariableEffect
PUBLIC_TOKEN_<NAME>Exposes {{<NAME>}} as a build-time placeholder in prose. See Content tokens.

Deployment

VariableDefaultEffect
BASE_PATH(empty)Sub-path deploy prefix, e.g. /docs.
PORT3000Port the server listens on (container).

Container mounts

These only apply to the Docker image and point the entrypoint at alternate source directories — most users never change them.

VariableDefaultEffect
OPEN_DOCS_CONTENT/contentDirectory copied into src/content/.
OPEN_DOCS_STATIC/staticDirectory merged into static/.