Clarify 配置参考

clarify.ts > clarify.js > clarify.json

import { defineConfig } from '@clarify-labs/cli'

export default defineConfig({
  title: 'Clarify 文档',
  description: 'Clarify 官方文档 — 开源文档发布工具',
  siteUrl: 'https://docs.example.com',
  source: {
    repository: 'https://github.com/acme/docs',
    branch: 'main',
    directory: 'docs/source',
  },
  logo: {
    light: '/logo-light.svg',
    dark: '/logo-dark.svg',
  },
  favicon: '/favicon.ico',
  routePrefix: '/docs/',
  theme: {
    preset: 'default',
    editor: true,
    tokens: {
      colors: {
        primary: { light: '#00D492', dark: '#34D399' },
        accent: '#0D9488',
        muted: { light: '#64748b', dark: '#a1a1aa' },
      },
    },
  },
  navbar: {
    links: [
      { label: { 'zh-CN': '文档', 'en-US': 'Docs' }, href: '/getting-started' },
      { label: 'GitHub', href: 'https://github.com/taicode-labs/clarify', external: true },
    ],
  },
  banner: {
    content: { 'zh-CN': 'Clarify 正在快速迭代中', 'en-US': 'Clarify is evolving fast' },
    dismissible: true,
  },
  footer: {
    socials: {
      github: 'https://github.com/taicode-labs/clarify',
    },
    copyright: '© 2026 Clarify Team',
  },
  i18n: {
    defaultLocale: 'zh-CN',
    missing: 'fallback',
    locales: [
      { code: 'zh-CN', label: '简体中文', dir: 'ltr' },
      { code: 'en-US', label: 'English', dir: 'ltr' },
    ],
  },
  tabs: [
    {
      tab: { 'zh-CN': '文档', 'en-US': 'Docs' },
      icon: 'BookOpen',
      pages: 'FileTree',
    },
  ],
  ssg: {
    failOnError: true,
  },
  plugins: [],
})

export default defineConfig({
  siteUrl: 'https://docs.example.com',
  source: {
    repository: 'https://github.com/acme/docs',
    branch: 'main',
    directory: 'docs/source',
  },
})

type ClarifyLocalizedText = string | Record<string, string>

{
  label: {
    'zh-CN': '文档',
    'en-US': 'Docs',
  }
}

type ClarifyLogoConfig = string | { light?: string; dark?: string }
type ClarifyFaviconConfig = string | { light?: string; dark?: string }

export default defineConfig({
  logo: '/logo.svg',
  favicon: {
    light: '/favicon-light.svg',
    dark: '/favicon-dark.svg',
  },
})

theme: {
  preset?: 'default' | 'base'
  tokens?: ClarifyThemeTokensConfig
  layout?: ClarifyThemeLayoutConfig
  editor?: boolean
}

export default defineConfig({
  theme: {
    preset: 'base',
    editor: true,
    tokens: {
      colors: {
        primary: { light: '#00D492', dark: '#34D399' },
        accent: '#0D9488',
        background: { light: '#ffffff', dark: '#09090b' },
        foreground: { light: '#18181b', dark: '#fafafa' },
        surface: { light: '#f8fafc', dark: '#18181b' },
        muted: { light: '#64748b', dark: '#a1a1aa' },
        border: { light: '#e2e8f0', dark: '#27272a' },
        codeBackground: { light: '#0f172a', dark: '#020617' },
      },
    },
  },
})

# 页面未找到

你访问的页面不存在或已经移动。

- [快速开始](/getting-started)
- [配置参考](/reference/clarify-config)

type ClarifyNavbarLink = {
  label: ClarifyLocalizedText
  href: string
  external?: boolean
}

export default defineConfig({
  navbar: {
    links: [
      { label: '文档', href: '/getting-started' },
      { label: 'API', href: '/features/openapi' },
      { label: 'GitHub', href: 'https://github.com/taicode-labs/clarify', external: true },
    ],
  },
})

type ClarifyBannerConfig = {
  content: ClarifyLocalizedText
  dismissible?: boolean
}

export default defineConfig({
  banner: {
    content: 'Clarify v0.1 已发布',
    dismissible: true,
  },
})

type ClarifyFooterLink = {
  label: ClarifyLocalizedText
  href: string
  external?: boolean
}

type ClarifyFooterConfig = {
  links?: ClarifyFooterLink[]
  socials?: Record<string, string>
  copyright?: ClarifyLocalizedText
}

export default defineConfig({
  footer: {
    links: [
      { label: '快速开始', href: '/getting-started' },
      { label: '配置参考', href: '/reference/clarify-config' },
      { label: 'GitHub', href: 'https://github.com/taicode-labs/clarify', external: true },
    ],
    socials: {
      github: 'https://github.com/taicode-labs/clarify',
    },
    copyright: '© 2026 Clarify Team',
  },
})

type ClarifyI18nConfig = {
  defaultLocale?: string
  missing?: 'fallback' | '404' | 'hide'
  locales: Array<{
    code: string
    label: string
    dir?: 'ltr' | 'rtl'
  }>
}

type ClarifyTabsConfig = ClarifyTabItem[]

type ClarifyTabItem = {
  tab: ClarifyLocalizedText
  icon?: string
  pages?: ClarifyPagesConfig
}

type ClarifyPagesConfig = ClarifyPagesGroup[] | 'FileTree'

export default defineConfig({
  tabs: [
    {
      tab: '文档',
      icon: 'BookOpen',
      pages: 'FileTree',
    },
  ],
})

export default defineConfig({
  tabs: [
    {
      tab: { 'zh-CN': '指南', 'en-US': 'Guides' },
      icon: 'Rocket',
      pages: [
        {
          group: { 'zh-CN': '核心路径', 'en-US': 'Core Path' },
          icon: 'Rocket',
          pages: [
            { page: 'getting-started', title: '快速开始', icon: 'Rocket' },
            { page: 'guides/writing-content', title: '写作文档', icon: 'PenLine' },
            { page: 'guides/navigation', title: '配置站点', icon: 'SlidersHorizontal' },
          ],
        },
      ],
    },
    {
      tab: 'API',
      icon: 'BookOpenCheck',
      pages: [
        {
          group: 'API 文档',
          pages: [
            { openapi: 'api.openapi.json', title: 'API Reference', icon: 'BookOpenCheck' },
          ],
        },
      ],
    },
  ],
})

{
  page: 'guides',
  title: '指南',
  icon: 'BookOpen',
  redirect: '/guides/writing-content',
}

{
  openapi: 'api.openapi.json',
  title: 'Projects API',
  filter: {
    tags: ['Projects'],
  },
}

ssg: {
  failOnError?: boolean
}

plugins: ClarifyPlugin[]

CLI 参数 > clarify.ts/js/json > 默认值