İçeriğe geç

Giriş

Markdown olarak görüntüle GitHub üzerinde düzenle Dokümantasyon: 7b38e05

Onedocs, Next.js ve Fumadocs ile oluşturulmuş dokümantasyon siteleri için düzenler, bileşenler ve yardımcı işlevlerden oluşan bir settir. Markdown yazarsınız, sitenizi tek bir yapılandırma dosyasında tanımlarsınız ve Onedocs dokümantasyon kabuğunu, bir ana sayfayı ve SEO route'larını sağlar.

Mevcut bir uygulamaya dokümantasyon eklemek için değil, bağımsız dokümantasyon siteleri için tasarlanmıştır.

Onedocs neler ekler

Fumadocs üzerine, onedocs paketi şunları sağlar:

  • Düzenler - DocsLayout ve DocsPage; kenar çubuğu, arama, tema değiştirici ve içindekiler tablosu bulunan Fumadocs UI dokümantasyon düzenini sarar. HomePage ise hero bölümü, yükleme komutları, özellikler ve altbilgi içeren bir açılış sayfası oluşturur.
  • Tek yapılandırma dosyası - onedocs.config.ts başlığı, açıklamayı, logoyu, site simgesini, gezinme bağlantılarını, altbilgiyi ve ana sayfa içeriğini tutar.
  • MDX bileşenleri - mdxComponents bildirim kutularını, sekmeleri, kartları, adımları, akordeonları, dosya ağaçlarını, görsel yakınlaştırmayı ve tür tablolarını kaydeder; böylece sayfalarda bunlar içe aktarılmadan kullanılabilir.
  • CSS ön ayarı - Tek bir içe aktarma Tailwind CSS v4, Fumadocs UI temasını ve Onedocs düzen stillerini getirir.
  • SEO yardımcıları - sitemap.xml, robots.txt, llms.txt, llms-full.txt, sayfa meta verileri ve Open Graph görselleri için işlevler.

Kendinizin kurması gerekenler

Onedocs, Next.js veya Fumadocs paketini içermez. Bunlar, yanına yüklemeniz gereken eş bağımlılıklardır:

Kabuk
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

Ayrıca Tailwind CSS v4, Node.js 20.9 veya üzeri ve yaklaşık on küçük dosya gerekir: Next.js ve Fumadocs MDX yapılandırması, bir içerik kaynağı, kök düzen, dokümantasyon düzeni ve dokümantasyon sayfası route'u. Her birini Başlarken bölümünde bulabilirsiniz.

Ayarların konumları

Ne Konum
Site başlığı, logo, gezinme, altbilgi onedocs.config.ts, bkz. Yapılandırma
Ana sayfanın hero bölümü ve özellikleri onedocs.config.ts içindeki homepage; src/app/page.tsx içindeki HomePage tarafından oluşturulur
Dokümantasyon düzeni ve sayfaları src/app/docs/layout.tsx ve src/app/docs/[[...slug]]/page.tsx, bkz. Başlarken
İçerik klasörü ve kenar çubuğu sırası source.config.ts ve content/docs/meta.json
MDX bileşenleri mdxComponents, bkz. Bileşenler
Arama, site haritası, robots.txt, llms.txt src/app/ altındaki route dosyaları, bkz. SEO ve Arama
Meta veriler ve Open Graph görselleri onedocs/metadata ve onedocs/og, bkz. API Referansı

Felsefe

  • Markdown öncelikli - .md veya .mdx yazın, dokümantasyon hazır olsun
  • Tek yapılandırma dosyası - Site genelindeki ayarlar onedocs.config.ts içinde bulunur
  • Daha fazla kontrol - Daha fazla denetim mi gerekiyor? Doğrudan Fumadocs kullanın

Buradan başlayın