Next.js dokumentacija sistemoje Fumadocs

Maketai, pradinis puslapis ir SEO pagalbinės funkcijos dokumentacijos svetainėms, sukurtoms naudojant Next.js ir Fumadocs.

Terminalas

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

Pradžia

GitHub

Naujausia versija 0.1.27 2026-03-26 MIT Next.js 16, Node 20.9+

TSX

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>
  );
}

Praktinis pritaikymas

Onedocs perduoda vieną konfigūracijos objektą Fumadocs UI maketams.

Viena konfigūracija, vienas maketas

onedocs.config.ts saugomi svetainės pavadinimas, aprašymas ir GitHub saugykla, o DocsLayout nuskaito juos kartu su jūsų Fumadocs šaltinio puslapių medžiu.

Maketas atvaizduoja šoninę juostą, temos perjungiklį, GitHub nuorodą, sudarytą iš nav.github, ir paieškos dialogą, kuris pateikia užklausas jūsų pridėtam /api/search maršrutui.

Darbo pradžios vadove aprašyti kiti failai: turinio šaltinis, Next.js konfigūracija, šakninis maketas ir puslapio maršrutas.

Skaitykite darbo pradžios vadovą

Konfigūracija

import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Docs",
  description: "Documentation for my project",
  nav: {
    github: "username/repo",
  },
});

Dokumentacijos maketas

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>
  );
}

Paruošti maketai

DocsLayout, DocsPage ir HomePage suteikia dokumentacijos apvalkalą su šonine juosta, paieška ir turiniu bei nukreipimo puslapį.

Vienas konfigūracijos failas

defineConfig() faile onedocs.config.ts nustato pavadinimą, aprašymą, logotipą, naršymo nuorodas, poraštę, pradinio puslapio pagrindinę antraštę ir funkcijas.

Markdown pirmiausia

Rašykite .md arba .mdx failus turinio aplanke; kiekviename puslapyje bus sintaksės paryškinimas ir turinys.

Paieška

Fumadocs integruota Orama paieška. Pridėkite vieną API maršrutą su createFromSource, ir paieškos dialogas jį naudos.

Tamsusis režimas

Šviesiąją ir tamsiąją temas suteikia Fumadocs UI, o dokumentacijos makete yra temos perjungiklis. Logotipai ir favicon gali turėti šviesiąsias ir tamsiąsias versijas.

Paruošta TypeScript

TypeScript palaikymas su tipų saugia konfigūracija ir automatinio užbaigimo funkcija redaktoriuje.

SEO ir llms.txt

Pagalbinės funkcijos, skirtos sitemap.xml, robots.txt, llms.txt, llms-full.txt, puslapio metaduomenims ir Open Graph vaizdams.

Pritaikoma

Kai reikia daugiau dokumentacijos kontrolės, galite tiesiogiai naudoti Fumadocs komponentus.

Peržiūrėkite išsamų Onedocs vadovą: nuo diegimo ir pirmojo naudojimo iki pažangių darbo eigų ir API informacijos.

Skaityti dokumentaciją

Peržiūrėti šaltinio kodą