mcpField
A
astro-starlight

astro-starlight

github.com/fusengineDevelopment3450 installsUpdated 2w ago
Repository

About astro-starlight

A skill for setting up and customizing Astro Starlight documentation sites. It covers navigation, search, plugins, multilingual content, and Starlight-specific Content Layer integration.

Key features

  1. 01Filesystem or manual sidebar setup
  2. 02Pagefind search and DocSearch guidance
  3. 03Dark and light theme customization
  4. 04Documentation plugin configuration
  5. 05Multilingual docs with hreflang
  6. 06Starlight Content Layer integration

Use cases

  1. 01Creating a technical documentation site
  2. 02Adding API reference or TypeScript docs
  3. 03Adding a blog or versioned docs
  4. 04Publishing documentation in multiple languages

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/fusengine/agents --skill astro-starlight

After installing, type/astro-starlightin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
content-layer.md
customization.md
i18n-multilang.md
plugins.md
search.md
setup.md
sidebar-config.md
references/templates/
sidebar-example.md
starlight-config.md

Details

From the project README
Sets up and customizes Astro Starlight (0.42+, latest 0.42.4; requires Astro 7.2.10+ — 0.41 dropped Astro 6), the documentation theme built on Astro 7: filesystem-based or manual sidebar configuration, built-in Pagefind full-text search (or DocSearch for high-traffic/large docs), automatic dark/light mode, and the plugin ecosystem — `starlight-blog`, `starlight-openapi`, `starlight-typedoc`, `starlight-versions`, `starlight-llms-txt` for AI discoverability.

Also covers multi-language documentation with hreflang support and Content Layer API integration (docsLoader, schema) specific to Starlight's content model, plus CSS custom property theming. Does not cover generic Astro Content Layer usage outside Starlight (astro-content) or non-Starlight i18n routing (astro-i18n) — those are handled by their own skills.

Astro Starlight

Production-ready documentation theme for Astro with built-in search, dark mode, i18n, and rich plugin ecosystem.

Agent Workflow (MANDATORY)

Before ANY implementation, spawn 3 agents in parallel, one Agent call each with a name:

  1. fuse-ai-pilot:explore-codebase - Analyze existing Starlight config, sidebar, and content structure
  2. fuse-ai-pilot:research-expert - Verify Starlight plugin APIs via Context7/Exa
  3. mcp__context7__query-docs - Check Starlight docs for Content Layer and i18n patterns

After implementation, run fuse-ai-pilot:sniper for validation.


Overview

When to Use
  • Building technical documentation sites
  • Creating API reference docs (with starlight-openapi)
  • Generating docs from TypeScript types (with starlight-typedoc)
  • Adding a blog to a documentation site (with starlight-blog)
  • Setting up versioned documentation (with starlight-versions)
  • Multi-language documentation with hreflang support
Why Starlight
FeatureBenefit
Pagefind built-inFull-text search, zero config
Dark/light modeAutomatic, CSS custom properties
Sidebar configFilesystem-based or manual groups
Plugin ecosystemDocSearch, blog, openapi, typedoc
Content Layer APIAstro 7 content collections integration
llms.txt supportstarlight-llms-txt for AI discoverability
No-JS mobile menu (0.42)Popover API — menu works with JS disabled; ships compiled JS + .d.ts (faster tsc)

Reference Guide

Concepts
TopicReferenceWhen to Consult
Setupsetup.mdInstallation, project structure
Sidebarsidebar-config.mdNavigation, groups, auto-gen
Searchsearch.mdPagefind, DocSearch, exclude pages
Pluginsplugins.mdBlog, openapi, typedoc, versions
i18ni18n-multilang.mdLocales, translations, hreflang
Content Layercontent-layer.mddocsLoader, schema, collections
Customizationcustomization.mdCSS variables, components override
Templates
TemplateWhen to Use
starlight-config.mdFull astro.config.mjs with Starlight
sidebar-example.mdComplex sidebar with groups and badges

Best Practices

  1. Start with filesystem sidebar - Add manual config only when needed
  2. Keep Pagefind for small sites - DocSearch for high-traffic or large docs
  3. Use starlight-llms-txt - AI crawlers increasingly important for docs
  4. Content Layer schema - Type-safe frontmatter prevents runtime errors
  5. CSS custom properties - Override theme without component slots

Comments

Markdown supported