Структура проекта

Это руководство покажет вам, как организован проект Starlight и какую роль выполняют различные файлы в вашем проекте.

Проекты Starlight, как правило, следуют той же структуре файлов и каталогов, что и другие проекты Astro. Подробнее смотрите в документации по структуре проекта Astro.

Файлы и папки

• astro.config.mjs — Файл конфигурации Astro; включает интеграцию и конфигурацию Starlight.
• src/content/config.ts — Файл конфигурации коллекций контента; добавляет метаданные (frontmatter) от Starlight в ваш проект.
• 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
    • config.ts
  • env.d.ts
• astro.config.mjs
• package.json
• tsconfig.json