Fumadocs

Fumadocs, geliştiricilerin React ve Next.js kullanarak profesyonel dokümantasyon siteleri oluşturmasına yardımcı olan bir dokümantasyon çerçevesidir. Geleneksel dokümantasyon araçlarının aksine, içeriğiniz ve tasarımınız üzerinde tam kontrol sağlar ve karmaşık kısımları otomatik olarak yönetir.

İçerik yazımını Markdown ve MDX formatlarında destekler; bu da basit metin biçimlendirmesi yapabileceğiniz veya etkileşimli React bileşenleri ekleyebileceğiniz anlamına gelir. Çerçeve, yerleşik arama, sözdizimi vurgulama ve güzel önceden tasarlanmış temalar içerir. Ayrıca, dokümanlarınızı dosyalarda, bir veritabanında veya bir içerik yönetim sisteminde depolasanız da herhangi bir içerik kaynağı ile çalışır.

Fumadocs, dokümanlarınızı yönetmek için bir içerik katmanı, arama gibi özellikler için bir çekirdek kütüphane ve güzel bileşenler için bir kullanıcı arayüzü kütüphanesi olmak üzere üç bölüm etrafında inşa edilmiştir. Sadece ihtiyacınız olanı kullanabilirsiniz.

Fumadocs ile başlaması oldukça basittir. İşte adımlar:

• Framework'ü kurun terminalinizde npm create fumadocs-app komutunu çalıştırarak. İstendiğinde tercih ettiğiniz React framework'ü ve içerik kaynağını seçin.

• İçeriğinizi yazın docs klasörü içindeki MDX dosyalarında. Basit Markdown sözdizimini kullanabilir ve etkileşimli öğeler için React bileşenleri ekleyebilirsiniz.

• Görünümü özelleştirin Tailwind CSS kullanarak. Renkleri, düzenleri ve stilleri markanıza uygun şekilde değiştirebilirsiniz, yeni bir sistem öğrenmenize gerek yoktur.

• Arama işlevi ekleyin Orama veya Algolia aramasını sadece birkaç satır kodla bağlayarak. Framework geri kalanını otomatik olarak halleder.

• CLI aracını kullanın sekmeler, çağrılar ve kod blokları gibi etkileşimli bileşenler eklemek için npx @fumadocs/cli add komutunu kullanın.

• Web sitenizi dağıtın Vercel, Netlify veya Next.js uygulamalarını destekleyen herhangi bir barındırma hizmetine.

• Ücretsiz ve açık kaynaklı çerçeve

• Next.js, React Router ve diğer React çerçeveleri ile uyumlu

• İçerik Markdown ve MDX ile yazılır

• Orama ve Algolia desteği ile yerleşik arama

• OpenAPI dokümantasyon oluşturucu

• TypeScript Twoslash entegrasyonu

• Güzel önceden tasarlanmış UI bileşenleri

• Kolay kurulum için komut satırı aracı

• Shiki ile sözdizimi vurgulama

• Tailwind CSS ile yüksek derecede özelleştirilebilir