Giriş
Fumadocs (Foo-ma docs), Next.js üzerine kurulu hızlı ve esnek bir belgeleme çerçevesidir. Next.js App Router ile sorunsuz biçimde birleşir.
Fumadocs'un ayrı parçaları vardır:
Fumadocs Core
Belge araması, içerik kaynağı bağdaştırıcıları ve Markdown uzantıları dahil mantığın büyük bölümünü üstlenir.
Fumadocs UI
Fumadocs'un varsayılan teması, belge siteleri ve etkileşimli bileşenler için düzenli bir görünüm sunar.
Content Source
İçeriğinizin kaynağı bir CMS olabilir veya Fumadocs MDX gibi yerel bir veri katmanı olabilir (resmi içerik kaynağı).
Fumadocs CLI
Arayüz bileşenlerini kurmak ve işleri otomatikleştirmek için bir komut satırı aracıdır. Yerleşimleri özelleştirirken işe yarar.
Daha fazlasını öğrenmek ister misiniz?
Ayrıntılı What is Fumadocs girişini okuyun.
Terminoloji
Markdown/MDX: Markdown, biçimli metin oluşturmak için bir işaretleme dilidir. Fumadocs, Markdown ve MDX'i (Markdown'ın üst kümesi) hazır olarak destekler.
Zorunlu değildir, ancak sonraki özelleştirmeler için Next.js App Router hakkında temel bilgi yararlı olur.
Otomatik kurulum
En az Node.js 18 gerekir. Node.js 23.1, Next.js üretim derlemesinde sorun çıkarabilir.
npm create fumadocs-appSize şunları sorar:
- Kullanılacak React.js çerçevesi (belgeler yalnızca Next.js için yazılmıştır).
- Kullanılacak içerik kaynağı.
Yeni bir fumadocs uygulaması başlatılır. Artık geliştirmeye başlayabilirsiniz.
Var olan bir kod tabanından mı?
Başlamak için Manual Installation kılavuzunu izleyebilirsiniz.
Keyfini çıkarın!
docs klasöründe ilk MDX dosyanızı oluşturun.
---
title: Hello World
---
## Yo what's upUygulamayı geliştirme kipinde çalıştırın ve http://localhost:3000/docs adresine bakın.
npm run devSSS
Karşılaşabileceğiniz bazı yaygın sorular.
Fumadocs'u yükseltme
Bir sorunla karşılaştığınızda veya yeni özellikleri denediğinizde Fumadocs'u yükseltin:
pnpm update -i -r --latestDaha fazla bilgi
Burada yeni misiniz? Sorularınızı bekliyoruz.
Kafa karıştıran bir şey bulursanız Github Discussion üzerinde geri bildirim verin.
İçerik yazmak
Belge yazmak için şunları okuyun:
Markdown
Fumadocs, içerik yazmak için bazı ek özellikler sunar.
Navigation
Gezinti bağlantılarını ve kenar çubuğu öğelerini nasıl özelleştireceğinizi öğrenin.
Routing
İçeriği nasıl düzenleyeceğinizi öğrenin.
Components
Belgelerinizi zenginleştirmek için kullanılabilir tüm bileşenleri görün