Next.js dokumentáció Fumadocs-hez

Elrendezések, kezdőlap és SEO segédfüggvények a Next.js és Fumadocs használatával készült dokumentációs webhelyekhez.

Terminál

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

Kezdés

GitHub

Legújabb kiadás 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>
  );
}

A gyakorlatban

A Onedocs egyetlen konfigurációs objektumot ad át a Fumadocs UI elrendezéseinek.

Egy konfiguráció, egy elrendezés

A onedocs.config.ts tartalmazza a webhely címét, leírását és GitHub tárházát; a DocsLayout pedig a Fumadocs forrás oldalfájával együtt olvassa be.

Az elrendezés megjeleníti az oldalsávot, a témaváltót, az nav.github alapján létrehozott GitHub hivatkozást és a keresőablakot, amely az Ön által hozzáadott /api/search útvonalat használja.

A Kezdő lépések útmutató ismerteti a többi fájlt: a tartalomforrást, a Next.js konfigurációt, a gyökérelrendezést és az oldal útvonalát.

Olvassa el az Első lépések útmutatót

Konfiguráció

import { defineConfig } from "onedocs/config";

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

Dokumentációs elrendezés

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

Előre elkészített elrendezések

A DocsLayout, a DocsPage és a HomePage oldalsávval, kereséssel és tartalomjegyzékkel ellátott dokumentációs keretet, valamint nyitóoldalt biztosít.

Egyetlen konfigurációs fájl

Az onedocs.config.ts fájlban a defineConfig() állítja be a címet, a leírást, a logót, a navigációs hivatkozásokat, a láblécet, valamint a kezdőlap kiemelt részét és funkcióit.

Először a Markdown

Írjon .md vagy .mdx fájlokat a tartalommappába; minden oldalon van szintaxiskiemelés és tartalomjegyzék.

Keresés

A Fumadocs beépített Orama keresője. Adjon hozzá egyetlen API útvonalat a createFromSource használatával, és a keresőablak már használhatja is.

Sötét mód

A világos és sötét témát az Fumadocs UI biztosítja, a dokumentációs elrendezés pedig tartalmaz témaváltót. A logók és a faviconok világos és sötét változatokat is elfogadnak.

TypeScript-ra kész

TypeScript támogatás típusbiztos konfigurációval és automatikus kódkiegészítéssel a szerkesztőben.

SEO és llms.txt

Segédfüggvények a sitemap.xml, robots.txt, llms.txt, llms-full.txt, az oldalmetaadatok és a Open Graph képek kezelésére.

Testreszabható

Kibúvók az Fumadocs összetevőihez, ha nagyobb kontrollra van szüksége a dokumentáció felett.

Fedezze fel a Onedocs teljes útmutatóját a telepítéstől és az első használattól a haladó munkafolyamatokon és az API részletein át.

Dokumentáció megtekintése

Forrás megtekintése