项目结构

本指南将向你展示 Starlight 项目的组织方式以及项目中不同文件的作用。

Starlight 项目通常遵循与其他 Astro 项目相同的文件和目录结构。更多详细信息，请参阅 Astro 的项目结构文档。

文件和目录

• astro.config.mjs — Astro 配置文件；包含 Starlight 集成和配置。
• src/content.config.ts — 内容集合配置文件；将 Starlight 的 frontmatter 模式添加到你的项目中。
• src/content/docs/ — 内容文件。Starlight 会将此目录中的每个 .md、.mdx 或 .mdoc 文件转换为你网站上的一个页面。
• src/content/i18n/ （可选）— 用于支持国际化的翻译数据。
• src/ — 项目的其他源代码和文件（组件、样式、图片等）。
• public/ — 静态资源（字体、网站图标、PDF 等），不会被 Astro 处理。

项目内容示例

一个 Starlight 项目目录可能如下所示

• 目录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