Lewati ke konten

Struktur Proyek

Panduan ini akan menunjukkan bagaimana susunan proyek Starlight dan apa yang dilakukan oleh file-file tersebut di dalam proyek Anda.

Proyek Starlight umumnya mengikuti struktur file dan direktori yang sama dengan proyek Astro lainnya. Lihat dokumentasi struktur proyek Astro untuk lebih detail.

File dan direktori

  • astro.config.mjs — File konfigurasi Astro; mencakup integrasi dan konfigurasi Starlight.
  • src/content/config.ts — File konfigurasi koleksi konten; menambahkan skema frontmatter Starlight ke proyek Anda.
  • src/content/docs/ — File konten. Starlight mengubah setiap file .md, .mdx, atau .mdoc dalam direktori ini menjadi halaman di website Anda.
  • src/content/i18n/ (opsional) — Data terjemahan untuk mendukung internasionalisasi.
  • src/ — Kode sumber dan file lainnya (komponen, style, gambar, dll.) untuk proyek Anda.
  • public/ — Aset statis (font, favicon, PDF, dll.) yang tidak akan diproses oleh Astro.

Isi proyek contoh

Sebuah direktori proyek Starlight mungkin terlihat seperti ini:

  • Directorypublic/
    • favicon.svg
  • Directorysrc/
    • Directoryassets/
      • logo.svg
      • screenshot.jpg
    • Directorycomponents/
      • CustomButton.astro
      • InteractiveWidget.jsx
    • Directorycontent/
      • Directorydocs/
        • Directoryguides/
          • 01-getting-started.md
          • 02-advanced.md
        • index.mdx
      • config.ts
    • env.d.ts
  • astro.config.mjs
  • package.json
  • tsconfig.json