Documentația Next.js pentru Fumadocs
Structuri, o pagină principală și utilitare SEO pentru site-uri de documentație create cu Next.js și Fumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562Cea mai recentă versiune 0.1.27 MIT Next.js 16, Node 20.9+
import { HomePage, CTASection } from "onedocs";
export default function Home() {
return (
<HomePage config={config} packageName="my-package">
<CTASection
title="Ready to get started?"
cta={{ label: "Read the Docs", href: "/docs" }}
/>
</HomePage>
);
}În practică
Onedocs transmite un obiect de configurare către structurile Fumadocs UI.
O configurare, o structură
onedocs.config.ts conține titlul și descrierea site-ului și depozitul GitHub, iar DocsLayout îl citește împreună cu arborele de pagini din sursa Fumadocs.
Structura redă bara laterală, comutatorul de temă, un link GitHub construit din nav.github și dialogul de căutare, care interoghează o rută /api/search pe care o adăugați.
Ghidul Noțiuni introductive prezintă celelalte fișiere: sursa conținutului, configurarea Next.js, structura rădăcină și ruta paginii.
import { defineConfig } from "onedocs/config";
export default defineConfig({
title: "My Docs",
description: "Documentation for my project",
nav: {
github: "username/repo",
},
});import { DocsLayout } from "onedocs";
import type { ReactNode } from "react";
import { source } from "@/lib/source";
import config from "../../../onedocs.config";
export default function Layout({ children }: { children: ReactNode }) {
return (
<DocsLayout config={config} pageTree={source.pageTree}>
{children}
</DocsLayout>
);
}Structuri gata făcute
DocsLayout, DocsPage și HomePage vă oferă structura documentației cu bară laterală, căutare și cuprins, plus o pagină de destinație.
Un singur fișier de configurare
defineConfig() din onedocs.config.ts setează titlul, descrierea, logo-ul, linkurile de navigare, subsolul, precum și secțiunea principală și funcționalitățile paginii principale.
Markdown pe primul loc
Scrieți fișiere .md sau .mdx în dosarul de conținut, cu evidențierea sintaxei și un cuprins pe fiecare pagină.
Căutare
Căutarea Orama încorporată în Fumadocs. Adăugați o singură rută API cu createFromSource, iar dialogul de căutare o va folosi.
Mod întunecat
Temele luminoasă și întunecată provin din Fumadocs UI, iar structura documentației include comutatorul de temă. Logo-urile și favicon-urile acceptă variante luminoase și întunecate.
Pregătit pentru TypeScript
Compatibilitate cu TypeScript, prin configurare sigură din punctul de vedere al tipurilor și completare automată în editor.
SEO și llms.txt
Utilitare pentru sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadatele paginii și imaginile Open Graph.
Personalizabil
Posibilitatea de a folosi direct componentele Fumadocs când aveți nevoie de mai mult control asupra documentației.
Explorați ghidul complet Onedocs, de la instalare și prima utilizare până la fluxuri de lucru avansate și detalii despre API.