Elle Kurulum

Yeni bir Starlight sitesi yapmanın en hızlı yolu, Başlangıç Rehberi‘nde gösterildiği gibi create astro komutunu kullanmak. Mevcut Astro projesine Starlight eklemek istersen, bu rehber nasıl yapılacağını açıklar.

Starlight Kurulumu

Bu rehberi takip edebilmen için mevcut Astro projesine ihtiyacın olacak.

Starlight Entegrasyonunun Eklenmesi

Starlight bir Astro entegrasyonu‘dur. Projenin kök dizininde astro add komutunu çalıştırarak sitene ekle:

npm

npx astro add starlight

pnpm

pnpm astro add starlight

Yarn

yarn astro add starlight

Bu adım, gerekli bağımlılıkları yükleyecek ve Astro yapılandırma dosyasındaki integrations dizisine Starlight’ı ekleyecek.

Entegrasyon Yapılandırması

Starlight entegrasyonu astro.config.mjs dosyanda yapılandırılmıştır.

Başlangıç için bir başlık (title) ekle:

// astro.config.mjs
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

export default defineConfig({
	integrations: [
		starlight({
			title: 'Benim harika dokümantasyon sitem',
		}),
	],
});

Geçerli olan tüm ayarları Starlight Yapılandırma Referansı‘nda bulabilirsin.

İçerik Koleksiyonlarının Yapılandırılması

Starlight, Astro’nun src/content/config.ts dosyasında yapılandırılan içerik koleksiyonları üzerine kurulmuştur.

Starlight’ın docsSchema isimli şemasını kullanan docs isimli koleksiyon ekleyerek içerik yapılandırma dosyasını oluştur ya da güncelle:

// src/content/config.ts
import { defineCollection } from 'astro:content';
import { docsSchema } from '@astrojs/starlight/schema';

export const collections = {
	docs: defineCollection({ schema: docsSchema() }),
};

İçerik Ekleme

Starlight’ın yapılandırması artık tamamladı. Şimdi sıra içerik eklemekte!

src/content/docs/ dizinini oluştur ve index.md dosyasını ekle. Bu, sitenin ana sayfası olacak.

---
# src/content/docs/index.md
title: Dokümanlarım
description: Starlight ile yapılmış bu dokümantasyon sitesinde projem ile ilgili daha fazlasını öğren.
---

Projeme hoşgeldin!

Starlight dosya bazlı yönlendirme kullanır, bu da src/content/docs/ dizini altındaki her Markdown, MDX ya da Markdoc dosyasını sitende bir sayfaya dönüştüreceği anlamına gelir. Frontmatter metadata (yukarıdaki örnekte yer alan title ve description alanları) görüntülenen her sayfada değişebilir. Geçerli olan tüm ayarları frontmatter referansı‘nda görebilirsin.

Var olan siteler için ipuçları

Hazır Astro projen varsa, Starlight’ı sitende dokümantasyon bölümü oluşturmak için kullanabilirsin.

Starlight’ın Alt Kırılımda Kullanımı

Tüm Starlight sayfalarını alt kırılımda eklemek için src/content/docs/ içinde alt dizin olarak tüm dokümanlarını ekle.

Örneğin, Starlight sayfaların /guides/ kırılımıyla başlaması gerekiyorsa, içeriklerini src/content/docs/guides/ dizininde ekle:

• Directorysrc/

  • Directorycontent/

    • Directorydocs/

      • Directoryguides/

        • guide.md
        • index.md
  • Directorypages/

    • …
• astro.config.mjs

Bu kullanımı, src/content/docs/ dizini içinde ekstra alt dizin ihtiyacını kaldırmak için gelecekte daha iyi desteklemeyi planlıyoruz.

Starliht’ın SSR ile Kullanımı

Mevcut olarak Starlight Astro’nun sunucu adaptörlerini kullanarak SSR dağıtımı‘nı desteklememektedir. Yakın zamanda desteklemeyi planlıyoruz.