Next.js dokumentācija ar Fumadocs
Izkārtojumi, sākumlapa un SEO palīgfunkcijas dokumentācijas vietnēm, kas veidotas ar Next.js un Fumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562Jaunākais laidiens 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>
);
}Praksē
Onedocs padod vienu konfigurācijas objektu izkārtojumiem Fumadocs UI.
Viena konfigurācija, viens izkārtojums
onedocs.config.ts glabā vietnes nosaukumu, aprakstu un GitHub repozitoriju, bet DocsLayout nolasa to kopā ar jūsu Fumadocs avota lapu koku.
Izkārtojums attēlo sānjoslu, tēmas pārslēgu, GitHub saiti, kas izveidota no nav.github, un meklēšanas dialogu, kas vaicā jūsu pievienotajam /api/search maršrutam.
Darba sākšanas pamācībā parādīti pārējie faili: satura avots, Next.js konfigurācija, saknes izkārtojums un lapas maršruts.
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>
);
}Gatavi izkārtojumi
DocsLayout, DocsPage un HomePage nodrošina dokumentācijas ietvaru ar sānjoslu, meklēšanu un satura rādītāju, kā arī galveno lapu.
Viens konfigurācijas fails
defineConfig() failā onedocs.config.ts iestata nosaukumu, aprakstu, logotipu, navigācijas saites, kājeni, kā arī sākumlapas galveno bloku un iespējas.
Markdown pirmajā vietā
Rakstiet .md vai .mdx failus satura mapē; katrā lapā būs sintakses izcelšana un satura rādītājs.
Meklēšana
Iebūvētā Orama meklēšana no Fumadocs. Pievienojiet vienu API maršrutu ar createFromSource, un meklēšanas dialogs to izmantos.
Tumšais režīms
Gaišo un tumšo tēmu nodrošina Fumadocs UI, un dokumentācijas izkārtojumā ir iekļauts tēmas pārslēgs. Logotipiem un vietņu ikonām var norādīt gaišā un tumšā režīma variantus.
Gatavs TypeScript
TypeScript atbalsts ar tipdrošu konfigurāciju un automātisko pabeigšanu redaktorā.
SEO un llms.txt
Palīgfunkcijas priekš sitemap.xml, robots.txt, llms.txt, llms-full.txt, lapu metadatiem un Open Graph attēliem.
Pielāgojams
Ja vajag lielāku kontroli pār dokumentāciju, izmantojiet tieši Fumadocs komponentus.
Iepazīstiet pilno Onedocs ceļvedi — no instalēšanas un pirmās lietošanas līdz padziļinātām darbplūsmām un API informācijai.