Skip to content

Starlight

Starlight is an Astro documentation theme that turns files into a help site with navigation and built-in search.

Visit Starlight

Where does a new help page come from?

Create a Starlight project in Astro and add a Markdown file under the docs content folder. Its title and other page settings sit at the top of the file. Astro builds the reader site. Your team maintains the project and deploys it to a compatible host.

What can you move if you change tools?

The project is MIT-licensed. Keep your Markdown or MDX, images and site settings. MDX can include components alongside text, so a different generator may need replacements for those components and changes to navigation. Hosting is a separate cost decision.

How would you check that a reader can find a new help page?

Sketch this with fictional material. Leave the real site, accounts and services alone.

  1. Write a title someone would search for
    Use “Change a workshop date” for a fictional booking service.
  2. Choose a phrase from the guide
    Mark which page should appear when a reader searches for “move my booking”. Use wording that actually appears in the page.
  3. Separate internal notes
    Put the staff checklist outside the public site and mark which files the host would receive.