Preskočiť na obsah

Konfigurácia

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

Nastavenia pre celý web patria do súboru onedocs.config.ts v koreňovom priečinku projektu. Exportovaný objekt odovzdajte komponentom DocsLayout, HomePage a createMetadata, ktoré ho čítajú. Umiestnenie obsahu sa nastavuje v source.config.ts, nie tu (pozrite si Začíname).

Základné nastavenie

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

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

To je minimum. Všetko ostatné je voliteľné.

Úplný príklad

Ikony funkcií sú prvky React, preto konfigurácia, ktorá ich používa, musí byť súbor .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" }],
  },
});

Možnosti

title (povinné)

Názov vašej stránky. Ak nie je nastavené logo, zobrazí sa v navigačnom paneli; createMetadata ho používa ako predvolený názov stránky a v šablóne %s | Title; domovská stránka ho používa ako názov hlavnej sekcie a v riadku autorských práv v päte.

TypeScript
title: "My Project"

description

Krátky opis. createMetadata ho používa ako meta opis a domovská stránka ho zobrazuje pod názvom hlavnej sekcie, ak nie je nastavené homepage.hero.description.

TypeScript
description: "Documentation for My Project"

Nahrádza názov v navigačnom paneli. Použite jednu cestu alebo svetlý a tmavý variant; obrázok má výšku 24 px a ako alternatívny text používa title.

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

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

ikona

Ikona stránky nastavená prostredníctvom createMetadata. Svetlé a tmavé varianty sa poskytujú pomocou mediálnych dotazov prefers-color-scheme.

TypeScript
icon: "/icon.png"

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

Konfigurácia navigačného panela používaná komponentmi DocsLayout a 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

Hlavná sekcia a mriežka funkcií, ktoré vykresľuje 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 sa vykreslí tak, ako je zadané, preto odovzdajte prvok, napríklad ikonu lucide-react. Reťazec ako "rocket" sa vypíše ako text.

Ďalšie dve možnosti hlavnej sekcie nahrádzajú časti predvolenej hlavnej sekcie:

  • hero.left nahrádza názov, opis, blok inštalácie a tlačidlo vlastným obsahom. Prijíma uzol React alebo funkciu, ktorá ho vracia.
  • hero.right vypĺňa pravú polovicu hlavnej sekcie. Pod bodom lg sa skryje.

Odkazy a ikony sociálnych sietí v päte HomePage vedľa riadka autorských práv. Obe sa otvárajú na novej karte.

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

Každý odkaz na sociálnu sieť používa label ako prístupný názov.

Možnosti, ktoré zatiaľ nemajú účinok

OnedocsConfig tiež typuje docs, theme a i18n a defineConfig dopĺňa predvolené hodnoty docs.dir a theme.darkMode, no žiadny kód Onedocs ich nečíta (#2). Ich nastavenie nič nemení:

  • docs.dir: priečinok obsahu je dir, ktorý odovzdávate defineDocs v source.config.ts.
  • theme.primaryColor a theme.darkMode: farby pochádzajú z témy Fumadocs UI, ktorú importuje predvoľba CSS, a svetlý a tmavý režim pochádzajú z Fumadocs UI cez RootProvider.
  • i18n: Onedocs nepodporuje viac jazykov.

TypeScript

Pomocná funkcia defineConfig poskytuje úplné automatické dopĺňanie:

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

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

export default defineConfig(config);

defineConfig vracia odovzdaný objekt spolu s nepoužívanými predvolenými hodnotami docs a theme opísanými vyššie.