Przejdź do treści

Konfiguracja

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

Ustawienia całej witryny umieść w onedocs.config.ts w katalogu głównym projektu. Przekaż wyeksportowany obiekt do DocsLayout, HomePage i createMetadata, które go odczytują. Lokalizację treści określa source.config.ts, a nie ten plik (zobacz Pierwsze kroki).

Podstawowa konfiguracja

TypeScript
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Project",
  description: "Documentation for My Project",
});

To wszystko, co niezbędne. Cała reszta jest opcjonalna.

Pełny przykład

Ikony funkcji są elementami React, więc konfiguracja, która ich używa, musi znajdować się w pliku .tsx:

TSX
import { defineConfig } from "onedocs/config";
import { Rocket, Zap } from "lucide-react";

export default defineConfig({
  title: "My Project",
  description: "Documentation for My Project",

  // Logo (string or light/dark variants)
  logo: "/logo.svg",
  // logo: { light: "/logo-light.svg", dark: "/logo-dark.svg" },

  // Favicon (string or light/dark variants), used by createMetadata
  icon: "/icon.png",

  // Navigation bar
  nav: {
    links: [
      { label: "Blog", href: "/blog" },
      { label: "Changelog", href: "/changelog" },
    ],
    github: "username/repo",
  },

  // Homepage
  homepage: {
    hero: {
      title: "My Project",
      description: "Documentation that ships with the code",
      cta: { label: "Get Started", href: "/docs" },
    },
    features: [
      {
        title: "Fast",
        description: "Static pages built by Next.js",
        icon: <Zap className="size-5 text-fd-primary" />,
      },
      {
        title: "Simple",
        description: "Write markdown, get docs",
        icon: <Rocket className="size-5 text-fd-primary" />,
      },
    ],
  },

  // Homepage footer
  footer: {
    links: [{ label: "License", href: "https://github.com/username/repo/blob/main/LICENSE" }],
  },
});

Opcje

title (wymagane)

Nazwa witryny. Pasek nawigacyjny wyświetla ją, jeśli nie ustawiono logo, createMetadata używa jej jako domyślnego tytułu strony i w szablonie %s | Title, a strona główna wykorzystuje ją jako tytuł sekcji głównej i w informacji o prawach autorskich w stopce.

TypeScript
title: "My Project"

description

Krótki opis. createMetadata używa go jako opisu meta, a strona główna wyświetla go pod tytułem sekcji głównej, jeśli nie ustawiono homepage.hero.description.

TypeScript
description: "Documentation for My Project"

Zastępuje tytuł w pasku nawigacyjnym. Użyj jednej ścieżki albo wariantów jasnego i ciemnego motywu; obraz ma 24 px wysokości, a jego tekstem alternatywnym jest title.

TypeScript
// Single logo
logo: "/logo.svg"

// Light/dark mode
logo: {
  light: "/logo-light.svg",
  dark: "/logo-dark.svg"
}

Ikona

Ikona favicon ustawiana przez createMetadata. Warianty jasne i ciemne są wyświetlane za pomocą zapytań o media prefers-color-scheme.

TypeScript
icon: "/icon.png"

// Light/dark mode
icon: {
  light: "/icon-light.png",
  dark: "/icon-dark.png"
}

Konfiguracja paska nawigacyjnego używana przez DocsLayout i HomePage.

TypeScript
nav: {
  // Extra links in the navbar
  links: [
    { label: "Blog", href: "/blog" },
    { label: "API", href: "/api" },
  ],

  // GitHub repo as "owner/name" (adds an icon link to https://github.com/owner/name)
  github: "username/repo",
}

homepage

Sekcja główna i siatka funkcji renderowane przez HomePage.

TSX
homepage: {
  hero: {
    title: "My Project",        // Defaults to config.title
    description: "Description", // Defaults to config.description
    cta: {
      label: "Get Started",     // Default: "Get Started"
      href: "/docs",            // Default: "/docs"
    },
  },
  features: [
    {
      title: "Feature 1",
      description: "Description of feature 1",
      icon: <Rocket className="size-5" />, // Optional React element
    },
  ],
}

icon jest renderowane w podanej postaci, więc przekaż element, taki jak ikona lucide-react. Ciąg znaków, taki jak "rocket", zostanie wyświetlony jako tekst.

Dwie dodatkowe opcje sekcji głównej zastępują jej domyślne elementy:

  • hero.left zastępuje tytuł, opis, blok instalacji i przycisk własną treścią. Przyjmuje węzeł React lub funkcję, która go zwraca.
  • hero.right wypełnia prawą połowę sekcji głównej. Jest ukrywane poniżej punktu przerwania lg.

Linki i ikony mediów społecznościowych w stopce HomePage, obok informacji o prawach autorskich. Oba typy otwierają się w nowej karcie.

TSX
// import { GitHubIcon } from "onedocs";
footer: {
  links: [{ label: "Privacy", href: "/privacy" }],
  socials: [
    { label: "GitHub", href: "https://github.com/username/repo", icon: <GitHubIcon /> },
  ],
}

Każdy link do mediów społecznościowych używa label jako dostępnej nazwy.

Opcje, które jeszcze nie działają

OnedocsConfig określa także typy docs, theme i i18n, a defineConfig uzupełnia domyślne wartości docs.dir i theme.darkMode, ale żaden kod Onedocs ich nie odczytuje (#2). Ich ustawienie niczego nie zmienia:

  • docs.dir: folder z treścią to dir przekazywane do defineDocs w source.config.ts.
  • theme.primaryColor i theme.darkMode: kolory pochodzą z motywu Fumadocs UI importowanego przez ustawienie wstępne CSS, a tryby jasny i ciemny z Fumadocs UI RootProvider.
  • i18n: Onedocs nie obsługuje wielu języków.

TypeScript

Funkcja pomocnicza defineConfig zapewnia pełne autouzupełnianie:

TypeScript
import { defineConfig, type OnedocsConfig } from "onedocs/config";

const config: OnedocsConfig = {
  title: "My Project",
};

export default defineConfig(config);

defineConfig zwraca przekazany obiekt oraz nieużywane domyślne wartości docs i theme opisane powyżej.