Penyiapan Awal Tema

1. Untuk memulai, pasang dulu semua paket yang diperlukan dengan npm install atau pnpm install, lalu jalankan build awal untuk memastikan penyiapannya berjalan dengan npm run build atau pnpm build.
2. Salin hasil build Pagefind (untuk pencarian situs) agar tersedia di lingkungan pengembangan. Caranya berbeda tergantung sistem operasi Anda. Saya sudah menyiapkan beberapa perintah untuk membantu.
   • Untuk Windows, jalankan npm run winsearch
   • Untuk OSX atau Linux, jalankan npm run osxsearch
3. Berikutnya, Anda perlu mengonfigurasi penyiapan i18n situs Anda (satu bahasa atau beberapa bahasa). Cukup jalankan perintah npm run docs:config-i18n lalu ikuti petunjuk skripnya sampai selesai!
4. Sekarang Anda bisa menyesuaikan situs sesuai keinginan Anda!

Pengantar kode

Saya sudah membuat beberapa code tour untuk memperkenalkan Anda pada basis kode ini. Anda memerlukan ekstensi Code Tour untuk melihatnya di VSCode atau IDE lain.

Struktur kode

Kode disusun dengan sebagian besar berkas berada di dalam direktori src/docs. Ini memudahkan Anda menyalin seluruh folder tersebut ke proyek yang sudah ada dan menambahkan fungsi dokumentasi hanya dalam hitungan menit.

Opsi konfigurasi

Konfigurasi situs secara keseluruhan dilakukan di folder src/docs/config/. Sebagian besar pengaturan berada di dalam folder bahasa masing-masing agar penanganan terjemahan lebih mudah.

Pengaturan situs

Berkas src/docs/config/siteSettings.json.ts digunakan untuk mengatur pengaturan situs. Isinya mencakup hal-hal seperti apakah view transition diaktifkan, apakah animasi diaktifkan, dan apakah tombol salin tautan ditampilkan pada judul dokumentasi.

Data situs

Berkas src/docs/config/[language]/siteData.json.ts digunakan untuk mengatur data situs. Isinya mencakup hal-hal seperti judul situs, deskripsi, tautan media sosial, dan gambar bawaan.

Data navigasi

Atur data navigasi untuk bilah navigasi atas di berkas src/docs/config/[language]/navData.json.ts.

Tata letak sidebar

Atur urutan bagian dokumentasi Anda di berkas src/docs/config/[language]/sidebarNavData.json.ts.

Robots

Agar robot seperti Google membaca sitemap yang benar, ubah berkas public/robots.txt supaya menggunakan domain situs web Anda.

Sumber daya lainnya

Informasi umum tentang Astro

Astro mencari berkas .astro atau .md di dalam direktori src/pages/. Setiap halaman dijadikan rute berdasarkan nama berkasnya.

Tidak ada yang istimewa dari src/components/, tetapi di sanalah kami biasa menaruh komponen Astro/React/Vue/Svelte/Preact.

Aset statis, seperti gambar, dapat ditempatkan di direktori public/. Saya juga sering memakai src/assets untuk gambar ketika menggunakan Astro assets demi optimasi gambar.

Perintah

Semua perintah dijalankan dari root proyek, melalui terminal:

Perintah	Aksi
npm install	Memasang dependensi
npm run dev	Menjalankan server dev lokal di localhost:4321
npm run build	Membangun situs produksi Anda ke ./dist/
npm run preview	Melihat pratinjau build secara lokal sebelum deploy
npm run astro ...	Menjalankan perintah CLI seperti astro add, astro check
npm run astro -- --help	Mendapatkan bantuan penggunaan Astro CLI

Ingin tahu lebih banyak?

Silakan lihat dokumentasinya atau bergabung ke server Discord.