Lewati ke konten

Pendahuluan

Lihat sebagai Markdown Edit di GitHub Dokumentasi di 7b38e05

Onedocs adalah kumpulan tata letak, komponen, dan helper untuk situs dokumentasi yang dibuat dengan Next.js dan Fumadocs. Anda menulis Markdown, menjelaskan situs dalam satu file config, lalu Onedocs menyediakan kerangka dokumentasi, halaman beranda, dan rute SEO.

Paket ini ditujukan untuk situs dokumentasi mandiri, bukan untuk menambahkan dokumentasi ke aplikasi yang sudah ada.

Fitur yang ditambahkan Onedocs

Selain Fumadocs, paket onedocs menyediakan:

  • Tata letak - DocsLayout dan DocsPage membungkus tata letak dokumentasi Fumadocs UI, dengan sidebar, pencarian, pengalih tema, dan daftar isi. HomePage merender halaman landing dengan hero, perintah instalasi, fitur, dan footer.
  • Satu file config - onedocs.config.ts menyimpan judul, deskripsi, logo, favicon, tautan navigasi, footer, dan konten halaman beranda.
  • Komponen MDX - mdxComponents mendaftarkan callout, tab, kartu, langkah, akordeon, pohon file, zoom gambar, dan tabel tipe agar halaman dapat menggunakannya tanpa impor.
  • Preset CSS - satu impor menyertakan Tailwind CSS v4, tema Fumadocs UI, dan gaya tata letak Onedocs.
  • Helper SEO - fungsi untuk sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadata halaman, dan gambar Open Graph.

Yang Anda siapkan sendiri

Onedocs tidak menyertakan Next.js atau Fumadocs. Keduanya adalah dependensi peer yang Anda instal bersama paket ini:

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

Anda juga memerlukan Tailwind CSS v4, Node.js 20.9 atau yang lebih baru, dan sekitar sepuluh file kecil: config Next.js dan Fumadocs MDX, sumber konten, tata letak root, tata letak dokumentasi, dan rute halaman dokumentasi. Memulai menunjukkan masing-masing file.

Lokasi konfigurasi

Apa Lokasi
Judul situs, logo, navigasi, footer onedocs.config.ts, lihat Konfigurasi
Hero dan fitur halaman beranda homepage di onedocs.config.ts, dirender oleh HomePage di src/app/page.tsx
Tata letak dan halaman dokumentasi src/app/docs/layout.tsx dan src/app/docs/[[...slug]]/page.tsx, lihat Memulai
Folder konten dan urutan sidebar source.config.ts dan content/docs/meta.json
Komponen MDX mdxComponents, lihat Komponen
Pencarian, sitemap, robots.txt, llms.txt File rute di src/app/, lihat SEO & Pencarian
Metadata dan gambar Open Graph onedocs/metadata dan onedocs/og, lihat API Referensi

Filosofi

  • Markdown-dulu - Tulis .md atau .mdx, dapatkan dokumentasi
  • Satu file config - Pengaturan seluruh situs disimpan di onedocs.config.ts
  • Jalan keluar - Perlu kontrol lebih? Gunakan Fumadocs secara langsung

Mulai di sini