Already in use
starlight-versions for versioned docs and starlight-links-validator for
link checking.
Starlight extensions
This content is for 2025. Switch to the latest version for up-to-date documentation.
Starlight is deliberately extensible. This page records the extensions that are already in use and the ones that are worth considering if the docs surface expands.
Recommended only when needed
starlight-openapi for generated API docs, starlight-typedoc for
TypeScript surfaces, and starlight-blog if release notes should live in
the docs site.
Not recommended by default
Algolia DocSearch, unless the default Pagefind search becomes insufficient for the repository’s size or use case.
Recommended extensions
Section titled “Recommended extensions”| Extension | Why it matters | Current stance |
|---|---|---|
starlight-versions | Makes pricing-year docs explicit and navigable. | Installed and in use. |
starlight-links-validator | Catches broken internal docs links early. | Installed and in use. |
starlight-openapi | Useful if the repo publishes OpenAPI-backed API docs. | Recommended later if public API docs become first-class. |
starlight-typedoc | Useful if a TypeScript binding surface is documented. | Recommended only if a TypeScript surface becomes real. |
starlight-blog | Useful if release notes or announcements move into docs. | Optional. |
starlight-image-zoom | Useful for diagrams and screenshots in dense docs. | Optional. |
Current recommendation
Section titled “Current recommendation”For this repository, keep the docs stack small and specific:
- Keep
starlight-versions. - Keep
starlight-links-validator. - Add
starlight-openapionly if the public calculator contract becomes an OpenAPI-backed published surface. - Add
starlight-typedoconly if a TypeScript binding surface is committed to the docs site. - Leave Algolia DocSearch out unless Pagefind stops meeting the search need.