Doküman yazım bileşenleri

Geliştirme · 0.0.0-dev

Yayın

Doküman: 0.0.0-dev
Uygulama: 0.0.0

Bu sayfa

Uygulama: 0.0.0

Teknik belgelerde kod için dil etiketli fenced block, kısa ikincil bilgiler için aside ve ilişkileri göstermek için Mermaid flowchart kullanılır. Bu üç yapı Markdown kaynağında okunabilir kalmalı; yalnız görsel yerleşim için MDX eklenmez.

Kod

Dil etiketi zorunludur. Dosya veya bağlam adı gerekiyorsa title metadata’sı, kritik satırlar için Expressive Code satır işaretleri kullanılır.

select id, canonical_latin
from public.compounds
order by canonical_latin;

Callout

Kısa ve eyleme dönük notlar Starlight’ın yerleşik aside sözdizimini kullanır.

Diyagram

Diyagramlar yerel Mermaid paketiyle tarayıcıda çizilir. Kaynak metin statik HTML içinde kalır; her diyagram accTitle ve accDescr içermelidir.

flowchart LR
  accTitle: Dokümantasyon doğrulama akışı
  accDescr: Markdown kaynağı şema kontrolünden ve statik derlemeden geçerek sürümlü çıktıya dönüşür.
  A[Markdown kaynağı] --> B[Şema kontrolü]
  B --> C[Statik build]
  C --> D[Sürümlü çıktı]