Začíname

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 7b38e05

Táto príručka nastaví web dokumentácie s Onedocs v prázdnom priečinku. Ak už máte projekt Next.js, preskočte súbory, ktoré už máte, a porovnajte zvyšok.

Predpoklady

Node.js 20.9 alebo novší (vyžaduje ho Next.js 16)
Next.js 16 s App Routerom, React 19.2 alebo novší
Tailwind CSS v4 (predvoľba Onedocs CSS importuje tailwindcss)

Fumadocs UI 16 podporuje iba Next.js 16 a React 19.2, takže staršie verzie Next.js alebo React nefungujú, hoci metadáta balíka onedocs ich stále uvádzajú (#5).

Inštalácia

Onedocs nepribaľuje Next.js ani Fumadocs. Ide o partnerské závislosti, preto ich nainštalujte spolu s ním:

Shell

npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
npm install -D tailwindcss @tailwindcss/postcss typescript @types/react @types/react-dom @types/node

Ponechajte pripnutú verziu lucide-react@0.562. onedocs 0.1.27 deklaruje lucide-react ^0.562.0 ako partnerskú závislosť; bez pripnutia npm nainštaluje lucide-react 1.x a skončí s chybou ERESOLVE (#1).

Rovnaké balíky fungujú s pnpm, yarn alebo bun.

Pridajte skripty Next.js do package.json:

JSON

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}

Štruktúra projektu

Výsledná štruktúra bude takáto:

Kód

your-project/
├── content/
│   └── docs/
│       ├── index.mdx
│       └── meta.json
├── public/
│   └── fonts/
│       └── InterVariable.woff2
├── src/
│   ├── app/
│   │   ├── layout.tsx
│   │   ├── page.tsx
│   │   ├── globals.css
│   │   └── docs/
│   │       ├── layout.tsx
│   │       └── [[...slug]]/
│   │           └── page.tsx
│   └── lib/
│       └── source.ts
├── onedocs.config.ts
├── source.config.ts
├── next.config.mjs
├── postcss.config.mjs
├── tsconfig.json
└── package.json

Vytvorme jednotlivé súbory.

Konfiguračné súbory

onedocs.config.ts

Hlavný konfiguračný súbor. Povinné je iba title; ostatné možnosti nájdete v časti Konfigurácia.

TypeScript

import { defineConfig } from "onedocs/config";

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

source.config.ts

Určuje, kde sa v projekte Fumadocs MDX nachádza obsah. Toto je jediné miesto, kde sa nastavuje priečinok obsahu:

TypeScript

import { defineDocs } from "fumadocs-mdx/config";

export const docs = defineDocs({
  dir: "content/docs",
});

next.config.mjs

Zapína spracovanie MDX:

JavaScript

import { createMDX } from "fumadocs-mdx/next";

const withMDX = createMDX();

/** @type {import('next').NextConfig} */
const config = {};

export default withMDX(config);

Fumadocs MDX pri spustení Next.js vytvorí priečinok .source/ z source.config.ts. Pridajte .source do .gitignore.

postcss.config.mjs

Spúšťa Tailwind CSS v4, na ktorom je postavená predvoľba Onedocs CSS:

JavaScript

export default {
  plugins: {
    "@tailwindcss/postcss": {},
  },
};

tsconfig.json

Príklady nižšie importujú z @/, preto ho namapujte na src/:

JSON

{
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}

Next.js pri prvom spustení next dev alebo next build pridá do tohto súboru ďalšie potrebné možnosti kompilátora.

Nastavenie zdroja

src/lib/source.ts

Načíta obsah dokumentácie:

TypeScript

import { loader } from "fumadocs-core/source";
import { docs } from "../../.source/server";

export const source = loader({
  baseUrl: "/docs",
  source: docs.toFumadocsSource(),
});

Súbory aplikácie

src/app/layout.tsx

Koreňové rozloženie:

TSX

import type { Metadata } from "next";
import { RootProvider } from "fumadocs-ui/provider/next";
import { FontHead } from "onedocs";
import "./globals.css";

export const metadata: Metadata = {
  title: "My Docs",
  description: "Documentation for my project",
};

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <FontHead />
      </head>
      <body className="antialiased">
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}

RootProvider z Fumadocs UI poskytuje dialógové okno vyhľadávania a svetlú aj tmavú tému. FontHead prednačíta variabilné písmo Inter z /fonts/InterVariable.woff2 a nastaví ho ako písmo stránky. Onedocs nedodáva súbor písma: stiahnite InterVariable.woff2 z vydaní Inter a umiestnite ho do public/fonts/. Bez neho text použije systémové bezpätkové písmo.

Ak chcete tieto metadáta namiesto toho vytvárať z konfigurácie, pozrite si createMetadata v referencii API.

src/app/globals.css

Importujte predvoľbu CSS:

CSS

@import "onedocs/css/preset.css";

@source "./**/*.tsx";
@source "../../content/**/*.mdx";

Predvoľba načíta Tailwind CSS, štýly Fumadocs UI a štýly rozloženia Onedocs. Cesty @source sú relatívne k globals.css, takže tieto dva riadky ukazujú na src/app/ a na priečinok content/ v koreňovom priečinku projektu.

src/app/page.tsx

Domovská stránka. HomePage vykresľuje hlavnú sekciu, funkcie a pätu podľa vašej konfigurácie:

TSX

import { HomePage } from "onedocs";
import config from "../../onedocs.config";

export default function Home() {
  return <HomePage config={config} packageName="my-package" />;
}

packageName pridá do hlavnej sekcie príkazy na inštaláciu pre npm, yarn, pnpm a bun. Vynechajte ho, ak váš projekt nie je balíkom.

src/app/docs/layout.tsx

Rozloženie dokumentácie s bočným panelom:

TSX

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

src/app/docs/[[...slug]]/page.tsx

Jednotlivé stránky dokumentácie:

TSX

import { source } from "@/lib/source";
import { DocsPage, mdxComponents } from "onedocs";
import { notFound } from "next/navigation";

export default async function Page(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  const MDX = page.data.body;

  return (
    <DocsPage toc={page.data.toc}>
      <MDX components={mdxComponents} />
    </DocsPage>
  );
}

export async function generateStaticParams() {
  return source.generateParams();
}

export async function generateMetadata(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  return {
    title: page.data.title,
    description: page.data.description,
  };
}

Obsah

content/docs/index.mdx

Každá stránka potrebuje vo svojich metadátach title. description je voliteľné:

Mdx

---
title: Introduction
description: What this project does.
---

Welcome to the docs. Components such as `<Callout>` work without imports; see [Components](/docs/components).

content/docs/meta.json

Určuje poradie v bočnom paneli:

JSON

{
  "pages": ["index"]
}

Pridajte stránku vytvorením ďalšieho súboru .mdx a uvedením jeho názvu v pages.

Spustenie

Spustite vývojový server:

Shell

npm run dev

Domovská stránka je na adrese http://localhost:3000 a dokumentácia na adrese http://localhost:3000/docs.

Zostavte projekt pre produkčné prostredie:

Shell

npm run build

Potom pridajte vyhľadávanie, mapu webu a llms.txt v SEO & Search.