Scribe/scribe.config.ts at main · RapierCraft/Scribe · 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
import { ScribeConfig } from "./src/lib/types";

const config: ScribeConfig = {
  // Site metadata
  name: "Acme API",
  description: "The fastest way to build payment infrastructure. Simple, reliable, and developer-first.",
  url: "https://docs.acme.dev",

  // Branding
  logo: {
    light: "/logo-light.svg",
    dark: "/logo-dark.svg",
    text: "Acme API",
  },

  // Theme
  theme: {
    primaryColor: "#6366f1", // indigo-500
    font: "Inter",
    monoFont: "JetBrains Mono",
    radius: "0.5rem",
  },

  // Navigation
  navigation: [
    {
      title: "Getting Started",
      items: [
        { title: "Introduction", href: "/docs" },
        { title: "Installation", href: "/docs/getting-started/installation" },
        { title: "Quick Start", href: "/docs/getting-started/quickstart" },
        { title: "Authentication", href: "/docs/getting-started/authentication" },
      ],
    },
    {
      title: "API Reference",
      items: [
        { title: "Endpoints", href: "/docs/api/endpoints" },
        { title: "Request Format", href: "/docs/api/request-format" },
        { title: "Response Format", href: "/docs/api/response-format" },
        { title: "Error Codes", href: "/docs/api/errors" },
        { title: "Rate Limits", href: "/docs/api/rate-limits" },
      ],
    },
    {
      title: "Guides",
      items: [
        { title: "Configuration", href: "/docs/guides/configuration" },
        { title: "Webhooks", href: "/docs/guides/webhooks" },
        { title: "SDKs", href: "/docs/guides/sdks", badge: "New" },
        { title: "Deployment", href: "/docs/guides/deployment" },
        { title: "Theming", href: "/docs/guides/theming" },
      ],
    },
    {
      title: "Resources",
      items: [
        { title: "Changelog", href: "/docs/changelog" },
        { title: "Status Page", href: "https://status.acme.dev", external: true },
        { title: "Community", href: "https://discord.gg/acme", external: true },
      ],
    },
  ],

  // Top navigation bar links
  topNav: [
    { href: "/docs", label: "Docs" },
    { href: "/docs/api/endpoints", label: "API Reference" },
    { href: "/docs/guides/sdks", label: "SDKs" },
    { href: "https://github.com/rapiercraft/scribe", label: "GitHub", external: true },
  ],

  // Top bar actions
  actions: {
    primaryButton: { label: "Get Started", href: "/docs/getting-started/installation" },
    secondaryButton: { label: "GitHub", href: "https://github.com/rapiercraft/scribe" },
  },

  // Search
  search: {
    enabled: true,
    shortcut: "/",
  },

  // Version switcher
  versions: ["v2.0", "v1.9", "v1.8"],

  // Footer
  footer: {
    links: [
      { title: "GitHub", href: "https://github.com/rapiercraft/scribe" },
      { title: "Twitter", href: "https://twitter.com/acmeapi" },
      { title: "Discord", href: "https://discord.gg/acme" },
    ],
    copyright: "Acme Inc.",
  },

  // SEO
  seo: {
    titleTemplate: "%s | Acme API Docs",
    ogImage: "/og-image.png",
  },
};

export default config;