Pierwsze kroki

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 7b38e05

Ten przewodnik pokazuje, jak skonfigurować witrynę dokumentacji z Onedocs w pustym folderze. Jeśli masz już projekt Next.js, pomiń pliki, które już istnieją, i porównaj pozostałe.

Wymagania wstępne

Node.js 20.9 lub nowszy (wymagany przez Next.js 16)
Next.js 16 z App Routerem, React 19.2 lub nowszy
Tailwind CSS v4 (ustawienie wstępne Onedocs CSS importuje tailwindcss)

Fumadocs UI 16 obsługuje tylko Next.js 16 i React 19.2, dlatego starsze wersje Next.js lub React nie działają, mimo że metadane pakietu onedocs nadal je wymieniają (#5).

Instalacja

Onedocs nie zawiera Next.js ani Fumadocs. Są to zależności partnerskie, więc instalujesz je obok niego:

Powłoka

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

Zachowaj przypięcie lucide-react@0.562. onedocs 0.1.27 deklaruje lucide-react ^0.562.0 jako zależność partnerską, a bez przypięcia npm instaluje lucide-react 1.x i kończy działanie z błędem ERESOLVE (#1).

Te same pakiety działają z pnpm, yarn lub bun.

Dodaj skrypty Next.js do package.json:

JSON

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

Struktura projektu

Oto, co będzie gotowe na końcu:

Kod

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

Utwórzmy każdy z plików.

Pliki konfiguracyjne

onedocs.config.ts

Główny plik konfiguracyjny. Wymagane jest tylko title; pozostałe opcje znajdziesz w sekcji Konfiguracja.

TypeScript

import { defineConfig } from "onedocs/config";

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

source.config.ts

Informuje Fumadocs MDX, gdzie znajduje się treść. To jedyne miejsce, w którym ustawia się folder z treścią:

TypeScript

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

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

next.config.mjs

Włącza obsługę MDX:

JavaScript

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

const withMDX = createMDX();

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

export default withMDX(config);

Fumadocs MDX generuje folder .source/ z source.config.ts podczas uruchamiania Next.js. Dodaj .source do .gitignore.

postcss.config.mjs

Uruchamia Tailwind CSS v4, na którym opiera się ustawienie wstępne Onedocs CSS:

JavaScript

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

tsconfig.json

Poniższe przykłady importują z @/, więc przypisz mu ścieżkę src/:

JSON

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

Next.js dodaje do tego pliku pozostałe opcje kompilatora przy pierwszym uruchomieniu next dev lub next build.

Konfiguracja źródeł

src/lib/source.ts

Ładuje treść dokumentacji:

TypeScript

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

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

Pliki aplikacji

src/app/layout.tsx

Główny układ:

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 udostępnia okno wyszukiwania oraz jasny i ciemny motyw. FontHead wczytuje wstępnie czcionkę Inter Variable z /fonts/InterVariable.woff2 i ustawia ją jako czcionkę strony. Onedocs nie zawiera pliku czcionki: pobierz InterVariable.woff2 z wydań Inter i umieść go w public/fonts/. W przeciwnym razie tekst będzie wyświetlany czcionką bezszeryfową systemu.

Aby zbudować te metadane na podstawie konfiguracji, zobacz createMetadata w API—dokumentacji referencyjnej.

src/app/globals.css

Zaimportuj ustawienie wstępne CSS:

CSS

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

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

Ustawienie wstępne ładuje Tailwind CSS, style motywu Fumadocs UI oraz style układu Onedocs. Ścieżki @source są względne względem globals.css, więc te dwa wiersze wskazują src/app/ oraz folder content/ w katalogu głównym projektu.

src/app/page.tsx

Strona główna. HomePage renderuje sekcję główną, funkcje i stopkę na podstawie konfiguracji:

TSX

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

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

packageName dodaje do sekcji głównej polecenia instalacji npm, yarn, pnpm i bun. Pomiń tę opcję, jeśli projekt nie jest pakietem.

src/app/docs/layout.tsx

Układ dokumentacji z paskiem bocznym:

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

Poszczególne strony dokumentacji:

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

Treść

content/docs/index.mdx

Każda strona musi mieć title w metadanych frontmatter. description jest opcjonalne:

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

Ustawia kolejność na pasku bocznym:

JSON

{
  "pages": ["index"]
}

Dodaj stronę, tworząc kolejny plik .mdx i wpisując jego nazwę w pages.

Uruchomienie

Uruchom serwer deweloperski:

Powłoka

npm run dev

Strona główna jest pod adresem http://localhost:3000, a dokumentacja pod http://localhost:3000/docs.

Zbuduj wersję produkcyjną:

Powłoka

npm run build

Następnie dodaj wyszukiwanie, mapę witryny i llms.txt w sekcji SEO i wyszukiwanie.