İçeriğe geç

Bu belgeler üzerinde çalışmak

Bu site docs/ klasöründedir ve Astro Starlight ile yapılmıştır. Statik bir sitedir ve https://docs.zimmet.dev adresinden sunulur.

Terminal window
cd docs
npm install
npm run dev # http://localhost:4321
npm run build # statik çıktı: docs/dist
npm run preview # derlemeyi sunar

Sayfalar docs/src/content/docs/ altındaki Markdown veya MDX dosyalarıdır. Dosya yolu adresi belirler: guides/custody.md, /guides/custody/ adresinde sunulur.

Her kenar çubuğu grubu bir klasörden üretilir (getting-started, concepts, guides, reference, development). Grup içindeki sırayı frontmatter ile belirleyin:

---
title: Zimmet devirleri
description: Arama sonuçlarında ve bağlantı önizlemelerinde kullanılan tek bir cümle.
sidebar:
order: 1
---

Not ve uyarılar için aside kullanın:

:::caution[Demo kısıtı]
Hiçbir şey gönderilmez.
:::

Durum rozetleri uygulamanın renklerini kullanır: <span class="status bad">Arızalı</span> (sınıflar: ok, warn, idle, bad, off).

İngilizce sayfalar kök dizindedir, Türkçe sayfalar aynı yol yapısıyla tr/ altındadır: guides/custody.md sayfasının Türkçesi tr/guides/custody.md dosyasıdır ve /tr/guides/custody/ adresinde sunulur. Türkçe sayfalardaki iç bağlantılar /tr/ ile başlamalıdır.

Bir sayfanın Türkçesi yoksa Starlight İngilizcesini gösterir ve sayfanın henüz çevrilmediğini belirtir. Kenar çubuğu grup adlarının çevirileri astro.config.mjs içindeki translations alanındadır.

Bir İngilizce sayfayı değiştirdiğinizde Türkçesini de aynı değişiklikte güncelleyin.

Site, tanıtım sayfası gibi Workers Builds üzerinden statik dosya sunan bir Cloudflare Worker olarak yayınlanır:

Ayar Değer
Kök dizin /docs
Derleme komutu npm ci && npm run build
Yayınlama komutu npx wrangler deploy
Özel alan adı docs.zimmet.dev

docs/wrangler.jsonc, dist/ klasörünü statik dosya olarak sunar; bilinmeyen adreslerde 404.html gösterilir. Dosyadaki name, Cloudflare’deki Worker adıyla aynı olmalıdır. Bu dosya olmazsa wrangler Astro’yu algılar, @astrojs/cloudflare SSR adaptörünü kendiliğinden kurar ve derleme başarısız olur.

Kendi makinenizden yayınlamak için:

Terminal window
cd docs
npm run build
npx wrangler deploy

astro.config.mjs içindeki site değeri https://docs.zimmet.dev olarak ayarlıdır; kanonik adresler ve site haritası bunu kullanır. Alan adı değişirse orayı güncelleyin. public/_headers özetlenmiş dosyaları bir yıl önbelleğe alır, public/robots.txt tarayıcıları site haritasına yönlendirir.