centaur/docs/vocs.config.ts at main · paradigmxyz/centaur · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
import { createElement, Fragment } from 'react'
import { defineConfig } from 'vocs/config'

import { sidebar } from './sidebar.js'

const basePath = process.env.VOCS_BASE_PATH || undefined
const siteUrl = 'https://centaur.run'

function canonicalHref(path: string) {
  if (path === '/') return `${siteUrl}/`
  return `${siteUrl}${path.replace(/\/+$/, '')}/`
}

export default defineConfig({
  rootDir: '.',
  srcDir: '.',
  colorScheme: 'dark',
  renderStrategy: 'full-static',
  // The dead-link checker doesn't know about static assets shipped via
  // public/ (like our zip and brand SVGs), so downgrade to a warning rather
  // than failing the build.
  checkDeadlinks: 'warn',
  title: 'Centaur',
  titleTemplate: '%s - Centaur',
  description: 'The production control plane for shared AI agents, tools, workflows, and sandboxes.',
  // Browser-tab favicon: standalone centaur mark only (no background frame).
  // Vocs emits a per-scheme <link rel="icon"> pair so the tab shows the
  // black silhouette on light chrome and the white silhouette on dark.
  iconUrl: {
    light: '/brand/mark-black.svg',
    dark: '/brand/mark-white.svg',
  },
  // Top-left site logo: full lockup on docs routes (the sidebar / topNav
  // gets enough space to carry the wordmark). The landing page hides Vocs's
  // topNav entirely and renders its own lockup in the hero.
  logoUrl: {
    light: '/brand/lockup-black.svg',
    dark: '/brand/lockup-white.svg',
  },
  // Body copy uses Amp's PolySans via the pages/_root.css override. Docs headings
  // use Perfectly Nineties, while the landing hero uses Sagittaire Display.
  // Code blocks stay on Geist Mono.
  font: {
    mono: { google: 'Geist Mono' },
  },
  // Open Graph cards are pre-rendered at build time by scripts/build-og.ts.
  // Resolve them via a function so the slug logic stays in lockstep with
  // the build script: route /a/b -> /og/a_b.png, / -> /og/index.png. The
  // absolute URL form (baseUrl prefix) is required for Slack/Twitter/
  // Discord previews to resolve the image — relative paths fail in
  // every major unfurl previewer. New routes added under pages/ (e.g.
  // operate/slack-etl) get picked up automatically the next time the
  // prebuild script runs — no manual map maintenance required.
  ogImageUrl: (path: string, { baseUrl }: { baseUrl: string }) => {
    const key = path.replace(/\/$/, '') || '/'
    const slug = key === '/' ? 'index' : key.replace(/^\//, '').replace(/\//g, '_')
    const root = baseUrl ?? 'https://centaur.run'
    return `${root.replace(/\/$/, '')}/og/${slug}.png`
  },
  ...(basePath ? { basePath } : {}),
  editLink: {
    pattern: 'https://github.com/paradigmxyz/centaur/edit/main/docs/pages/:path',
    text: 'Edit this page',
  },
  // Per-page <head>: canonical URL for SEO plus the global font preload and
  // the centaur-brand-menu.js script that powers the right-click logo menu.
  head({ path }) {
    return createElement(Fragment, null,
      createElement('link', { rel: 'canonical', href: canonicalHref(path) }),
      createElement('link', {
        rel: 'preload',
        href: '/fonts/PerfectlyNineties-Regular.woff',
        as: 'font',
        type: 'font/woff',
        crossOrigin: '',
      }),
      createElement('link', {
        rel: 'preload',
        href: '/fonts/PolySans-variable.woff2',
        as: 'font',
        type: 'font/woff2',
        crossOrigin: '',
      }),
      createElement('link', {
        rel: 'preload',
        href: '/fonts/slack/lato-latin-400-normal.woff2',
        as: 'font',
        type: 'font/woff2',
        crossOrigin: '',
      }),
      createElement('script', { src: '/centaur-brand-menu.js', defer: true }),
    )
  },
  llms: {
    generateMarkdown: true,
  },
  markdown: {
    code: {
      themes: {
        dark: 'github-dark-default',
        light: 'github-dark-default',
      },
    },
  },
  topNav: [
    {
      text: 'GitHub',
      link: 'https://github.com/paradigmxyz/centaur',
    },
  ],
  search: {
    boostDocument(documentId) {
      if (documentId.includes('what-is-centaur')) return 4.5
      if (documentId.includes('quickstart')) return 4
      if (documentId.includes('operate/')) return 3.8
      if (documentId.includes('extend/')) return 3.8
      if (documentId.includes('secrets/')) return 3.8
      if (documentId.includes('security')) return 3.6
      if (documentId.includes('deploying-in-production')) return 3.5
      if (documentId.includes('architecture')) return 3
      return 1
    },
  },
  sidebar,
  theme: {
    // Keep in sync with --centaur-accent in docs/pages/_root.css.
    accentColor: {
      light: '#28c26a',
      dark: '#28c26a',
    },
    variables: {
      color: {
        background: {
          light: '#ffffff',
          dark: '#050505',
        },
        text: {
          light: '#050505',
          dark: '#f7f7f2',
        },
      },
      content: {
        width: '920px',
      },
    },
  },
})