Skip to content
prod e051e98
Browse

Starlight plugins in use

Installed · wired · blocked · MDX-only

This page is the runtime inventory of Starlight plugins for ZajLibrary — pulled from app/package.json and app/astro.config.mjs. For how to author with these tools, see Site Authoring Capabilities and the live demos in Component library.

StatusMeaning
WiredRegistered in astro.config.mjs (integrations or starlight({ plugins: [...] })) and active in dev + production builds.
MDX-onlyInstalled npm package; import components in .mdx — no plugins: [] entry required.
ParkedInstalled but intentionally not wired because it conflicts with current site overrides or no live page needs it yet.
BlockedInstalled but not wired — fails or breaks the build on Astro 6 / Zod 4 until upstream fixes.
CoreFramework integration — not optional.
PackageVersion (pinned)StatusWhat it does
@astrojs/starlight^0.39.3CoreDocs framework on Astro — content collections, sidebar, search (Pagefind), Starlight components, default theme hooks.
astro^6.3.1CoreStatic site builder (Vite 7, Node 22+). Starlight runs as an Astro integration.
Local zaj-mermaid integrationlocalWiredRenders ```mermaid fenced diagrams using Astro 6’s markdown.processor API plus the mermaid runtime.
mermaid^11.15.0DependencyDiagram engine used by the local zaj-mermaid integration.
starlight-theme-rapide^0.5.2WiredBase Starlight theme (CSS layer). Brand palette still wins via tokens.css + theme.css loaded after.
starlight-sidebar-topics^0.7.1WiredFive intent shelves (Learn · Build · Resources · Directories · System docs) — each with its own autogenerated sidebar + header section nav.
starlight-auto-sidebar^0.4.0WiredPer-folder _meta.yaml tuning (label, order, badge, collapsed) for autogenerated sidebar groups. Must load before @lorenzo_lewis/starlight-utils if multiSidebar is enabled.
@lorenzo_lewis/starlight-utils^0.3.2WiredNav utilities — optional navLinks (breadcrumbs) and multiSidebar switcher. Empty config today (middleware only; compatible with sidebar-topics).
starlight-heading-badges^0.7.0WiredStatus badges on page headings from status: current | target | future | draft frontmatter.
starlight-auto-drafts^0.3.0Wireddraft: true pages hidden in production builds; visible in npm run dev.
starlight-videos^0.4.0ParkedVideo guide / course layouts and components. Not wired today because it tries to own PageTitle and MarkdownContent, which ZajLibrary already overrides.
starlight-tags^1.0.1WiredTag index + one page per tag from tags: frontmatter. onInlineTagsNotFound: 'create' auto-creates missing tag routes (keeps links-validator green).
starlight-markdown-blocks^0.1.0WiredCustom ::: callout directives — idea, decision, start, next, summary.
starlight-links-validator^0.24.0WiredBuild gate — fails npm run build on broken internal links. Excludes /kits/** (static public/ assets).
starlight-scroll-to-top^1.0.1WiredFloating scroll-to-top control (right side).
starlight-image-zoom^0.14.2WiredClick-to-zoom on content images (screenshots stay legible).
starlight-github-alerts^0.2.0WiredGitHub-style markdown alerts: > [!NOTE], > [!TIP], > [!WARNING], etc.
starlight-llms-txt^0.10.0WiredGenerates /llms.txt — machine-readable site summary for LLM crawlers and agents.
starlight-kbd^0.4.0Wired<Kbd mac="…" windows="…" /> for platform-aware shortcut docs. globalPicker: false (custom header has no ThemeSelect slot for the picker).
starlight-package-managers^0.12.0MDX-only<PackageManagers> — synced npm / pnpm / yarn / bun tabs for install commands.
starlight-showcases^0.3.2MDX-onlyShowcase cards — <ShowcaseText>, profiles, quotes, embeds.
starlight-changelogs^0.5.0BlockedWould serve changelog pages from CHANGELOG.md + content collection. Not wired — v0.5.0 uses z.url() (Zod 3 API); Astro 6 ships Zod 4. Static fallback: Changelog.
PluginAuthor / reader effect
starlight-theme-rapideRapide shell — typography, spacing, default Starlight chrome. Overridden by Zaj paper-workbook CSS.
Custom Header.astroSecond-row shelf nav (desktop) from sidebar-topics data — not a plugin; site override.
Custom PageTitle.astro / Footer.astro“Copy as prompt” (title bar + page footer) + Open in ChatGPT/Claude — not a plugin; site overrides.
PluginAuthor / reader effect
starlight-sidebar-topicsFive top-level shelves; clicking a shelf switches sidebar tree. Topic exclude list handles tag pages and directory detail routes.
starlight-auto-sidebar_meta.yaml per folder — reorder groups, rename labels, add sidebar badges.
@lorenzo_lewis/starlight-utilsReady for breadcrumbs or multi-sidebar when IA needs them; currently no visible UI.
PluginAuthor / reader effect
starlight-markdown-blocks:::idea, :::decision, :::start, :::next, :::summary in .md / .mdx.
starlight-github-alertsStandard GitHub alert syntax in markdown.
starlight-heading-badgesVisual status on the page title from frontmatter.
starlight-package-managersPer-tool install commands without hand-maintaining four copies.
starlight-showcasesEditorial showcase cards on gallery / hub pages.
starlight-kbdKeyboard glyphs that respect macOS vs Windows labeling.
starlight-videosParked until a real video lesson page needs the override chain.
Local zaj-mermaid integrationFlowcharts, sequence diagrams, graphs in plain markdown fences.
PluginAuthor / reader effect
starlight-tags/tags/<tag>/ indexes every doc with that tag; link tags freely in prose.
starlight-llms-txt/llms.txt for agents and external LLM tools.
Pagefind (Starlight built-in)Full-text search index on production build — not a separate package.
PluginAuthor / reader effect
starlight-links-validatorNo shipping broken internal links — build fails instead.
starlight-auto-draftsWIP pages stay out of production until draft is removed.
PluginAuthor / reader effect
starlight-scroll-to-topLong playbook pages get a one-click return to top.
starlight-image-zoomZoom screenshots and figures without leaving the doc.
flowchart TB
  subgraph integrations["astro.config.mjs → integrations[]"]
    M[zaj-mermaid]
    S["@astrojs/starlight"]
    M --> S
  end
  subgraph plugins["starlight({ plugins: [...] }) — registration order"]
    T1[starlight-theme-rapide]
    T2[starlight-sidebar-topics]
    T3[starlight-auto-sidebar]
    T4[starlight-utils]
    T5[heading-badges · auto-drafts · tags · markdown-blocks]
    T6[links-validator · scroll-to-top · image-zoom · github-alerts · llms-txt · kbd]
    T1 --> T2 --> T3 --> T4 --> T5 --> T6
  end
  S --> plugins

Rules worth keeping:

  1. zaj-mermaid before Starlight — browser rendering is registered before Starlight pages render; Markdown conversion lives in top-level markdown.processor.
  2. starlight-auto-sidebar before starlight-utils — required if multiSidebar is ever turned on.
  3. starlight-theme-rapide first among plugins — its CSS is the base layer; customCss loads after and wins on tokens.
  4. New plugins — check peerDependencies against Starlight ^0.39 and Astro ^6; run npm run build before merging.
PluginOur config
starlight-sidebar-topicsFive shelves; topics.directory maps /directory/*/* detail pages; exclude for tags and directory detail routes that use the default sidebar.
starlight-tagsonInlineTagsNotFound: 'create', tagsIndexSlug: 'tag-index' — auto-create individual tag pages while the custom /tags/ explorer owns the main tags route.
starlight-markdown-blocksCustom blocks: idea (green), decision (purple), start (accent), next (orange), summary (blue).
starlight-links-validatorexclude: ['/kits/**'] — kit ZIPs live under public/, not Starlight routes.
starlight-kbdmacOS + Windows types; globalPicker: false because Header.astro overrides ThemeSelect.
starlight-changelogsCommented out — see Changelog.
  1. cd app && npm install <package> (or remove from package.json).
  2. Register in astro.config.mjs if it exposes a Starlight plugin (most starlight-* packages do; component-only packages do not).
  3. Update Site Authoring Capabilities if authors need to know about it.
  4. Add a demo to Component library when the plugin ships UI components.
  5. Run npm run build — links-validator and the new plugin’s own build hooks must pass.
  6. Record the change in Changelog and app/CHANGELOG.md.
PageUse it for
Site Authoring CapabilitiesAuthor-facing “what can I use on a page?” inventory (plugins + custom components + tokens).
Best Starlight Plugins — By PurposeWider catalog for evaluating future additions.
Component libraryLive regression gallery for Starlight + Zaj add-on components.
ChangelogWhen plugins were wired, blocked, or upgraded.