Starlight sites

Zeku recognizes a site built with Starlight, Astro’s documentation theme, and treats its docs collection the way Starlight does.

• URLs follow Starlight’s rule: a page’s slug field when it has one, otherwise its path in the collection, slugified, at the root of your site.
• The dashboard can sort pages by Sidebar, which follows the sidebar config in your astro.config.mjs, including groups you list by hand and folders Starlight fills in with autogenerate.
• New pages go in the section you choose, and in the locale you choose on a multilingual site.
• Asides written as :::note, :::tip, :::caution, and :::danger render in live preview, with a custom title as :::tip[Title] and a custom icon as :::tip{icon="heart"}. The icon comes from your own Starlight install, so it’s the one your site shows. A caution aside is orange and a danger aside is red, as in Starlight.
• Starlight’s components, such as Aside, Badge, Card, CardGrid, LinkCard, Steps, Tabs, and FileTree, are in the MDX insert menu. Zeku imports each one by name from @astrojs/starlight/components, added to the import you already have.
• The dashboard shows a page’s sidebar.label beside its title and its sidebar.badge in the badge’s color, and marks a page whose sidebar.hidden keeps it out of the sidebar.

Zeku knows Starlight’s own frontmatter fields, such as sidebar, template, draft, and hero, even before you run astro sync. Running it once still helps: it gives Zeku the exact types of any fields you add with extend.

These docs are a Starlight site, and they’re written in Zeku.