Skip to content

Starlight

Starlight is Astro’s official documentation theme. It’s designed for building fast, accessible documentation sites. Vault CMS has a dedicated preset that lets you manage Starlight content from Obsidian.

Starlight is not a blog theme. It’s a documentation framework with built-in sidebar navigation, search, dark mode, and internationalization support. When paired with Vault CMS, you can write and manage your docs entirely from Obsidian.

  • Sidebar navigation (auto-generated or manual)
  • Built-in search
  • Dark mode
  • Table of contents (auto-generated from headings)
  • Sitemap
  • Multiple color schemes
  • Internationalization support
  • Accessible by default
  • File-based docs in src/content/docs/
  • Uses Starlight’s built-in schema (docsSchema)
  • Frontmatter: title, description, sidebar options, template, hero configuration
Terminal window
npm create astro@latest -- --template starlight
npx create-vaultcms --template starlight

Open the project as a vault in Obsidian. The Starlight preset configures Vault CMS to work with Starlight’s content structure.

  • Documentation-only (no blog posts, tags, or cover images)
  • No RSS feed
  • No OG image generation
  • No wikilinks, callouts (uses Starlight’s own aside syntax), or Obsidian-specific markdown
  • No dedicated Obsidian settings plugin

Free and open source (MIT).