Multi-Scrobbler Docs #

Built with Astro Starlight. Served by the app at /docs and published to https://docs.multi-scrobbler.app.

npm install
npm start                # dev server, http://localhost:3001/docs/
npm run build            # build/
npm run preview          # serve build/ on :3001

# MDX lint: Sätteri (the default processor) silently accepts some malformed MDX that the unified pipeline rejects
MD_PROCESSOR=unified npm run build -- --outDir build-unified

• src/content/docs – pages. _-prefixed files/folders are partials, not pages. Folder labels/order: _meta.yml.
• public/ – static files. public/schemas/*.json and public/openapi.json are generated by the app (npm run schema / npm run openapi:docs in the repo root), as are the _env_configs/*.md tables.
• src/components – MDX components (auto-imported ones are listed in astro.config.mjs).
• plugins/ – base-path links, root sidebar, OpenAPI spec link fixes + old API URL redirects, Caddyfile grammar, changelog settings (GitHub release notes pages are only built with DOCS_CHANGELOGS=true, set in the env, docsite/.env or as a Docker build arg).

DOCS_BASE sets the base path (default /docs). BASE_SITE / DEPLOY_PRIME_URL / CF_PAGES_URL set the site URL, CANONICAL_HREF rewrites canonical links, GSITEVERIFICATION / RY_ANALYTICS / RY_ANALYTICS_SITEID add head tags.