コンテンツへスキップ

設定

Markdownとして表示 GitHubで編集 ドキュメント: 7b38e05

サイト全体の設定は、プロジェクトのルートにあるonedocs.config.tsに記述します。エクスポートしたオブジェクトをDocsLayout、HomePage、createMetadataに渡すと、それぞれが読み込みます。コンテンツの場所はここではなくsource.config.tsで設定します（はじめにを参照）。

基本設定

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

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

これが最小限の設定です。それ以外はすべて任意です。

完全な例

機能アイコンはReact要素なので、これを使う設定ファイルは.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" }],
  },
});

オプション

title（必須）

サイト名です。logoが設定されていない場合はナビゲーションバーに表示され、createMetadataではデフォルトのページタイトルと%s | Titleテンプレートで使われます。ホームページではヒーローのタイトルとフッターの著作権表示にも使われます。

TypeScript
title: "My Project"

説明

短い説明文です。createMetadataがメタディスクリプションに使い、homepage.hero.descriptionが設定されていない場合はホームページのヒーロータイトルの下に表示します。

TypeScript
description: "Documentation for My Project"

ナビゲーションバーのタイトルを置き換えます。単一のパス、またはライト用とダーク用の画像を指定できます。画像の高さは24 pxで、代替テキストにはtitleを使います。

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

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

アイコン

createMetadataで設定するファビコンです。ライト用とダーク用の画像はprefers-color-schemeメディアクエリで配信されます。

TypeScript
icon: "/icon.png"

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

DocsLayoutと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が描画するヒーローと機能グリッドです。

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は指定したとおりに描画されるため、lucide-reactアイコンなどの要素を渡します。"rocket"のような文字列はテキストとして表示されます。

デフォルトのヒーローの一部を置き換えるオプションが、ほかに2つあります。

  • hero.leftを使うと、タイトル、説明、インストール用ブロック、ボタンを独自のコンテンツに置き換えられます。Reactノード、またはノードを返す関数を指定します。
  • hero.rightはヒーローの右半分に表示されます。lgブレークポイント未満では非表示になります。

HomePageフッターの著作権表示の横に置くリンクとソーシャルアイコンです。どちらも新しいタブで開きます。

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

各ソーシャルリンクでは、アクセス可能な名前としてlabelを使います。

まだ効果のないオプション

OnedocsConfigはdocs、theme、i18nの型も定義し、defineConfigはdocs.dirとtheme.darkModeのデフォルト値を設定しますが、これらを読み込むOnedocsのコードはありません（#2）。設定しても何も変わりません。

  • docs.dir：コンテンツフォルダーは、source.config.tsでdefineDocsに渡すdirです。
  • theme.primaryColorとtheme.darkMode：色はCSSプリセットが読み込むFumadocsのUIテーマから取得し、ライトモードとダークモードはFumadocs UIのRootProviderから取得します。
  • i18n：Onedocsは多言語に対応していません。

TypeScript

defineConfigヘルパーを使うと、完全な自動補完が利用できます。

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

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

export default defineConfig(config);

defineConfigは渡したオブジェクトに加え、上記の未使用のdocsとthemeのデフォルト値も返します。