Next.js: dokumentacija za Fumadocs
Postavitve, domača stran in pripomočki SEO za dokumentacijska spletna mesta, zgrajena z Next.js in Fumadocs.
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562Najnovejša izdaja 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 praksi
Onedocs posreduje en konfiguracijski objekt postavitvam dokumentacije Fumadocs UI.
Ena konfiguracija, ena postavitev
onedocs.config.ts vsebuje naslov in opis spletnega mesta ter repozitorij GitHub, DocsLayout pa ga bere skupaj z drevesom strani iz vira Fumadocs.
Postavitev izriše stransko vrstico, preklopnik teme, povezavo GitHub, ustvarjeno iz nav.github, in pogovorno okno za iskanje, ki poizveduje po poti /api/search, ki jo dodate.
Vodnik Uvod prikaže še preostale datoteke: vir vsebine, konfiguracijo Next.js, korensko postavitev in pot do strani.
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>
);
}Vnaprej pripravljene postavitve
DocsLayout, DocsPage in HomePage vam zagotovijo ogrodje dokumentacije s stransko vrstico, iskanjem in kazalom vsebine ter pristajalno stranjo.
Ena konfiguracijska datoteka
defineConfig() v onedocs.config.ts določa naslov, opis, logotip, navigacijske povezave, nogo strani ter uvodni pas in funkcije domače strani.
Najprej Markdown
V mapo z vsebino zapišite datoteke .md ali .mdx; na vsaki strani sta na voljo označevanje sintakse in kazalo vsebine.
Iskanje
Vgrajeno iskanje Orama v Fumadocs. Dodajte eno pot API s createFromSource in uporabi jo pogovorno okno za iskanje.
Temni način
Svetlo in temno temo zagotavlja Fumadocs UI, postavitev dokumentacije pa vključuje njegov preklopnik teme. Logotipi in ikone lahko uporabljajo svetle in temne različice.
Pripravljeno za TypeScript
Podpora za TypeScript s tipsko varno konfiguracijo in samodejnim dopolnjevanjem v urejevalniku.
SEO in llms.txt
Pomožne funkcije za sitemap.xml, robots.txt, llms.txt, llms-full.txt, metapodatke strani in slike Open Graph.
Prilagodljivo
Možnosti za uporabo komponent Fumadocs, ko potrebujete več nadzora nad dokumentacijo.
Raziščite celoten vodnik za Onedocs, od namestitve in prve uporabe do naprednih delovnih postopkov in podrobnosti API-ja.