Başlangıç Tema Kurulumu

1. Başlamak için önce npm install veya pnpm install ile gerekli tüm paketleri yükleyin, ardından kurulumun çalıştığından emin olmak için npm run build veya pnpm build ile bir ilk derleme çalıştırın.
2. Pagefind derlemesini (site araması için) geliştirme ortamında kullanılabilir olacak şekilde kopyalayın. Bu, işletim sisteminize göre değişir. Yardımcı olması için birkaç komut hazırladım.
   • Windows için npm run winsearch komutunu çalıştırın
   • OSX veya Linux için npm run osxsearch komutunu çalıştırın
3. Ardından sitenizin i18n yapılandırmasını (tek dil veya birden çok dil) ayarlamak isteyeceksiniz. npm run docs:config-i18n komutunu çalıştırın ve kurulumu tamamlamak için betiğin yönergelerini izleyin!
4. Artık siteyi dilediğiniz gibi düzenleyebilirsiniz!

Kod tanıtımları

Kod tabanını tanımanıza yardımcı olmak için birkaç kod turu hazırladım. Bunları VSCode’da veya başka bir IDE’de görüntülemek için Code Tour eklentisine ihtiyacınız olacak.

Kod yapısı

Kodun büyük bölümü src/docs dizini altında yapılandırılmıştır. Bu sayede klasörün tamamını mevcut bir projeye taşımak ve dokümantasyon işlevselliğini dakikalar içinde eklemek kolaylaşır.

Yapılandırma seçenekleri

Genel site yapılandırması src/docs/config/ klasöründe yapılır. Çevirilerin yönetimini kolaylaştırmak için ayarların çoğu ayrı dil klasörlerinin içinde bulunur.

Site ayarları

Site ayarlarını yapılandırmak için src/docs/config/siteSettings.json.ts dosyası kullanılır. Bunlar arasında görünüm geçişlerinin etkinleştirilip etkinleştirilmeyeceği, animasyonların açılıp açılmayacağı ve dokümantasyon başlıkları için bağlantı kopyalama düğmelerinin gösterilip gösterilmeyeceği gibi seçenekler yer alır.

Site verileri

Site verilerini yapılandırmak için src/docs/config/[language]/siteData.json.ts dosyası kullanılır. Buna site başlığı, açıklaması, sosyal medya bağlantıları ve varsayılan görsel gibi öğeler dahildir.

Gezinme verileri

Üst gezinme çubuğuna ait gezinme verilerinizi src/docs/config/[language]/navData.json.ts dosyasında yapılandırın.

Kenar çubuğu düzeni

Dokümantasyon bölümlerinizin sırasını src/docs/config/[language]/sidebarNavData.json.ts dosyasında yapılandırın.

Robots

Google gibi robotların doğru site haritasını görebilmesi için public/robots.txt dosyasını kendi web sitesi alan adınızı kullanacak şekilde düzenlemeniz gerekir.

Daha fazla kaynak

Genel Astro bilgileri

Astro, src/pages/ dizinindeki .astro veya .md dosyalarını arar. Her sayfa, dosya adına göre bir rota olarak sunulur.

src/components/ dizininin özel bir yanı yoktur, ancak Astro/React/Vue/Svelte/Preact bileşenlerini buraya koymayı tercih ediyoruz.

Görseller gibi statik dosyalar public/ dizinine yerleştirilebilir. Görsel optimizasyonu için Astro assets kullanırken görseller için sıklıkla src/assets dizinini de kullanıyorum.

Komutlar

Tüm komutlar, bir terminalden projenin kök dizininde çalıştırılır:

Komut	İşlem
npm install	Bağımlılıkları yükler
npm run dev	localhost:4321 adresinde yerel geliştirme sunucusunu başlatır
npm run build	Üretim sitenizi ./dist/ dizinine derler
npm run preview	Yayına almadan önce derlemenizi yerelde önizler
npm run astro ...	astro add, astro check gibi CLI komutlarını çalıştırır
npm run astro -- --help	Astro CLI kullanımı hakkında yardım gösterir

Daha fazlasını öğrenmek ister misiniz?

Dokümantasyona göz atabilir veya Discord sunucusuna katılabilirsiniz.