Skip to content
🌟 Starlight Starter 🚀

Starlight Starter Documentation

Want to learn what Starlight Starter can do for you?

This documentation, of course, uses Astro Starlight and demonstrates the various capabilities that Starlight Starter can provide.

Why does Starlight Starter exist?

Starlight is a great solution for creating documentation websites. It offers a wide range of built-in features, including:

  1. Responsive Design — desktops, tablets, and mobile devices
  2. Dark and Light mode — light, dark, and automatic modes
  3. Site Navigation — top navigation, sidebar, and table of contents
  4. Search Functionality — content is automatically searchable
  5. Built-in Components — Asides, Badges, Cards, File Trees, Icons, Tabs, and more
  6. Code highlighting — rich Expressive Code in markdown code blocks

However, I still find it necessary to install extra options to get desirable features such as:

  1. Blog — support blog content and related features
  2. Diagrams as Code — create fancy diagrams from text
  3. MathJax — produce pretty mathematical formulas from text
  4. PostHog Analytics — configure PostHog web analytics

Additionally, there are several projects settings that are desirable to keep it maintainable:

  1. Biome — format and lint your code
  2. Dependabot — keep your dependencies up to date
  3. GitHub Action Build — automatically build your project when pushed to GitHub

It quickly becomes easy to waste a lot of valuable time to configure a feature rich Starlight project. Rather than spending countless hours (if not days) configuring a Starlight project from the command-line, the idea to simply fill out a web form, choose your options, and download the project becomes compelling.

Focus on Content, Not Configuration!

I’ve spent hours automating the configuration so you don’t have to.

Next Steps

Check out this documentation to learn more about the available options. When you are ready, click configure to get started.

Configure

Then, download the preconfigured Starlight project and add your content to the src/content/docs folder. (You will see some sample Markdown files are already there. Those may be edited or removed.)

Please refer to the Starlight Documentation to learn more about adding pages.