Next.js-documentatie voor Fumadocs
Layouts, een startpagina en SEO-helpers voor documentatiesites gebouwd met Next.js en Fumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562Nieuwste release 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>
);
}In de praktijk
Onedocs geeft één configuratieobject door aan de layouts van Fumadocs UI.
Eén configuratie, één layout
onedocs.config.ts bevat de sitetitel, beschrijving en repository van GitHub, en DocsLayout leest deze samen met de paginaboom van uw bron Fumadocs.
De layout geeft de zijbalk en themaschakelaar weer, een GitHub-link opgebouwd uit nav.github, en het zoekvenster dat een route /api/search doorzoekt die u toevoegt.
De handleiding Aan de slag toont de overige bestanden: de contentbron, de configuratie Next.js, de hoofdlayout en de pageroute.
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>
);
}Kant-en-klare layouts
DocsLayout, DocsPage en HomePage bieden u een documentatieschil met zijbalk, zoeken en inhoudsopgave, plus een landingspagina.
Eén configuratiebestand
defineConfig() in onedocs.config.ts stelt de titel, beschrijving, het logo, navigatielinks, de voettekst en de hero en functies van de startpagina in.
Markdown eerst
Schrijf .md- of .mdx-bestanden in uw contentmap, met syntaxisaccentuering en een inhoudsopgave op elke pagina.
Zoek op
De ingebouwde Orama-zoekfunctie van Fumadocs. Voeg één API-route toe met createFromSource; het zoekvenster gebruikt die route.
Donkere modus
De lichte en donkere thema's komen van Fumadocs UI, en de documentatielayout bevat de themaschakelaar. Logo's en favicons ondersteunen lichte en donkere varianten.
Klaar voor TypeScript
Ondersteuning voor TypeScript met typeveilige configuratie en automatische aanvulling in uw editor.
SEO en llms.txt
Helpers voor sitemap.xml, robots.txt, llms.txt, llms-full.txt, paginametadata en Open Graph-afbeeldingen.
Aanpasbaar
Uitwijkmogelijkheden naar componenten van Fumadocs wanneer u meer controle over uw documentatie nodig hebt.
Ontdek de complete gids voor Onedocs, van installatie en eerste gebruik tot geavanceerde workflows en API-details.