Next.js dokumentatsioon raamistikule Fumadocs

Paigutused, avaleht ja SEO abifunktsioonid dokumentatsioonisaitidele, mis on loodud Next.js ja Fumadocs abil.

Terminal

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

Alustamine

GitHub

Viimane väljalase 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>
  );
}

Praktikas

Onedocs annab ühe seadistusobjekti Fumadocs UI paigutustele.

Üks seadistus, üks paigutus

onedocs.config.ts sisaldab saidi pealkirja, kirjeldust ja GitHub hoidlat ning DocsLayout loeb seda koos sinu Fumadocs lähte lehepuuga.

Paigutus kuvab külgriba, teemavahetuse, lingi nav.github põhjal loodud GitHub-le ja otsingu dialoogi, mis pärib andmeid sinu lisatud /api/search-marsruudilt.

Alustamisjuhend näitab ka teisi faile: sisulähte, Next.js seadistuse, juurpaigutuse ja lehemarsruudi.

Lugege alustamisjuhendit

Seadistus

import { defineConfig } from "onedocs/config";

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

Dokumentatsiooni paigutus

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

Valmis paigutused

DocsLayout, DocsPage ja HomePage annavad sulle dokumentatsioonisaidi põhja külgriba, otsingu ja sisukorraga ning lisaks sihtlehe.

Üks seadistusfail

defineConfig() failis onedocs.config.ts määrab pealkirja, kirjelduse, logo, navigeerimislingid, jaluse ning avalehe suure päiseosa ja funktsioonid.

Esmalt Markdown

Kirjuta sisukausta .md- või .mdx-faile; igal lehel on süntaksi esiletõstmine ja sisukord.

Otsi

Fumadocs sisseehitatud Orama otsing. Lisa üks API-marsruut funktsiooniga createFromSource ja otsingu dialoog kasutab seda.

Tume režiim

Heledad ja tumedad teemad tulevad Fumadocs UI-ist ning dokumentatsiooni paigutuses on teemavahetus. Logodele ja lemmikuikoonidele saab määrata heleda ja tumeda variandi.

TypeScript-valmis

TypeScript tugi koos tüübikindla seadistuse ja redaktori automaattäiendusega.

SEO ja llms.txt

Abifunktsioonid: sitemap.xml, robots.txt, llms.txt, llms-full.txt, lehe metaandmed ja Open Graph pildid.

Kohandatav

Vajaduse korral saad kasutada Fumadocs komponente, et dokumentatsiooni üle rohkem kontrolli saada.

Tutvu kogu Onedocs juhendiga, alates paigaldamisest ja esmakordsest kasutamisest kuni täiustatud töövoogude ja API üksikasjadeni.

Loe dokumentatsiooni

Vaata lähtekoodi