Next.js dokumentácia pre Fumadocs
Rozloženia, domovská stránka a pomocné funkcie SEO pre weby s dokumentáciou vytvorené pomocou Next.js a Fumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562Najnovšie vydanie 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>
);
}V praxi
Onedocs odovzdáva jeden konfiguračný objekt rozloženiam Fumadocs UI.
Jedna konfigurácia, jedno rozloženie
onedocs.config.ts obsahuje názov webu, opis a repozitár GitHub; DocsLayout ho načíta spolu so stromom stránok zo zdroja Fumadocs.
Rozloženie vykresľuje bočný panel, prepínač motívu, odkaz GitHub vytvorený z nav.github a dialóg vyhľadávania, ktorý vyhľadáva prostredníctvom trasy /api/search, ktorú pridáte.
Príručka Začíname opisuje ostatné súbory: zdroj obsahu, konfiguráciu Next.js, koreňové rozloženie a trasu stránky.
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>
);
}Hotové rozloženia
DocsLayout, DocsPage a HomePage poskytujú základ dokumentácie s bočným panelom, vyhľadávaním a obsahom, ako aj úvodnú stránku.
Jeden konfiguračný súbor
defineConfig() v onedocs.config.ts nastavuje názov, opis, logo, navigačné odkazy, pätu, hlavnú sekciu a funkcie domovskej stránky.
Najprv Markdown
Píšte súbory .md alebo .mdx do priečinka s obsahom; každá stránka bude mať zvýraznenie syntaxe a obsah.
Vyhľadávanie
Vstavané vyhľadávanie Orama v Fumadocs. Pridajte jednu trasu API pomocou createFromSource a využite ju v dialógu vyhľadávania.
Tmavý režim
Svetlý a tmavý motív pochádzajú z Fumadocs UI a rozloženie dokumentácie obsahuje ich prepínač. Logá a favikony môžu mať svetlú aj tmavú verziu.
Pripravené pre TypeScript
Podpora TypeScript s typovo bezpečnou konfiguráciou a automatickým dopĺňaním v editore.
SEO a llms.txt
Pomocné funkcie pre sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadáta stránok a obrázky Open Graph.
Prispôsobiteľné
Možnosti rozšírenia umožňujú použiť komponenty Fumadocs a získať väčšiu kontrolu nad dokumentáciou.
Preskúmajte kompletnú príručku Onedocs od inštalácie a prvého použitia až po pokročilé pracovné postupy a podrobnosti o API.