Fumadocs

Fumadocs adalah kerangka kerja dokumentasi yang membantu pengembang membangun situs dokumentasi profesional menggunakan React dan Next.js. Berbeda dengan alat dokumentasi tradisional, ini memberi Anda kendali penuh atas konten dan desain Anda sambil menangani bagian yang kompleks secara otomatis.

Ini mendukung penulisan konten dalam Markdown dan MDX, yang berarti Anda dapat menggunakan format teks sederhana atau menambahkan komponen React interaktif. Kerangka kerja ini mencakup pencarian bawaan, penyorotan sintaks, dan tema pra-desain yang indah. Ini juga bekerja dengan sumber konten apa pun, apakah Anda menyimpan dokumen Anda dalam file, basis data, atau sistem manajemen konten.

Fumadocs dibangun di sekitar tiga bagian: lapisan konten untuk mengelola dokumen Anda, perpustakaan inti untuk fitur seperti pencarian, dan perpustakaan UI untuk komponen yang indah. Anda dapat menggunakan hanya apa yang Anda butuhkan.

Memulai dengan Fumadocs sangat mudah. Berikut langkah-langkahnya:

• Pasang framework dengan menjalankan perintah npm create fumadocs-app di terminal Anda. Pilih framework React dan sumber konten yang Anda inginkan saat diminta.

• Tulis konten Anda dalam file MDX di dalam folder docs. Gunakan sintaks Markdown sederhana dengan opsi menambahkan komponen React untuk elemen interaktif.

• Kustomisasi tampilan menggunakan Tailwind CSS. Anda dapat mengubah warna, tata letak, dan gaya agar sesuai dengan merek Anda tanpa perlu mempelajari sistem baru.

• Tambahkan fungsi pencarian dengan menghubungkan pencarian Orama atau Algolia hanya dengan beberapa baris kode. Framework akan menangani sisanya secara otomatis.

• Gunakan alat CLI untuk menambahkan komponen interaktif seperti tab, callout, dan blok kode dengan perintah npx @fumadocs/cli add.

• Deploy situs Anda ke Vercel, Netlify, atau layanan hosting lain yang mendukung aplikasi Next.js.

• Kerangka kerja gratis dan sumber terbuka

• Bekerja dengan Next.js, React Router, dan kerangka kerja React lainnya

• Tulis konten dalam Markdown dan MDX

• Pencarian bawaan dengan dukungan Orama dan Algolia

• Generator dokumentasi OpenAPI

• Integrasi TypeScript Twoslash

• Komponen UI pra-desain yang indah

• Alat baris perintah untuk pengaturan mudah

• Penyorotan sintaks dengan Shiki

• Sangat dapat disesuaikan dengan Tailwind CSS