Skip to main content
Starlight

Search documentation

Type to search this documentation.

On this pageOverview

Project Structure

This guide will show you how a Starlight project is organized and what the different files in your project do.

Starlight projects generally follow the same file and directory structure as other Astro projects. See Astro’s project structure documentation for more detail.

  • astro.config.mjs — The Astro configuration file; includes the Starlight integration and configuration.
  • src/content.config.ts — Content collections configuration file; adds Starlight’s frontmatter schemas to your project.
  • src/content/docs/ — Content files. Starlight turns each .md, .mdx or .mdoc file in this directory into a page on your site.
  • src/content/i18n/ (optional) — Translation data to support internationalization.
  • src/ — Other source code and files (components, styles, images, etc.) for your project.
  • public/ — Static assets (fonts, favicon, PDFs, etc.) that will not be processed by Astro.

A Starlight project directory might look like this:

public
favicon.svg
src
assets
logo.svg
screenshot.jpg
components
CustomButton.astro
InteractiveWidget.jsx
content
docs
guides
01-getting-started.md
02-advanced.md
index.mdx
content.config.ts
astro.config.mjs
package.json
tsconfig.json
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu