clear-signing-docs/docusaurus.config.ts at main · sourcifyeth/clear-signing-docs · 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";

const config: Config = {
  title: "Clear Signing Docs",
  tagline:
    "Documentation for the ERC-7730 clear signing ecosystem: the registry, descriptors, and wallet integrations",
  favicon: "img/favicon.svg",

  future: {
    v4: true,
  },

  // Intended to be hosted under a clearsigning.org subdomain.
  url: "https://docs.clearsigning.org",
  baseUrl: "/",

  organizationName: "sourcifyeth",
  projectName: "clear-signing-docs",

  onBrokenLinks: "throw",

  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownLinks: "warn",
    },
  },

  themes: ["@docusaurus/theme-mermaid"],

  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          // Serve the docs at the site root — this is a docs-only site.
          routeBasePath: "/",
          editUrl:
            "https://github.com/sourcifyeth/clear-signing-docs/tree/main/",
        },
        blog: false,
        theme: {
          customCss: "./src/css/custom.css",
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    navbar: {
      title: "Clear Signing Docs",
      logo: {
        alt: "Clear Signing",
        src: "img/favicon.svg",
      },
      items: [
        {
          type: "docSidebar",
          sidebarId: "docsSidebar",
          position: "left",
          label: "Docs",
        },
        {
          href: "https://clearsigning.org",
          label: "clearsigning.org",
          position: "right",
        },
        {
          href: "https://github.com/ethereum/clear-signing-erc7730-registry",
          label: "Registry",
          position: "right",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Standard",
          items: [
            {
              label: "ERC-7730 specification",
              href: "https://eips.ethereum.org/EIPS/eip-7730",
            },
            {
              label: "clearsigning.org",
              href: "https://clearsigning.org",
            },
          ],
        },
        {
          title: "Registry",
          items: [
            {
              label: "ERC-7730 registry",
              href: "https://github.com/ethereum/clear-signing-erc7730-registry",
            },
            {
              label: "erc7730 CLI (python-erc7730)",
              href: "https://github.com/LedgerHQ/python-erc7730",
            },
          ],
        },
        {
          title: "SDKs",
          items: [
            {
              label: "TypeScript SDK",
              href: "https://github.com/sourcifyeth/clear-signing",
            },
            {
              label: "Rust / Swift / Kotlin SDK",
              href: "https://github.com/llbartekll/clear-signing",
            },
          ],
        },
      ],
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ["json", "bash", "solidity"],
    },
    tableOfContents: {
      minHeadingLevel: 2,
      maxHeadingLevel: 4,
    },
    // Match the clearsigning.org palette (accent blue, light info surfaces,
    // neutral grays). The same variables are used in light and dark mode —
    // diagram nodes render as light "cards" on the dark background.
    mermaid: {
      theme: { light: "base", dark: "base" },
      options: {
        themeVariables: {
          fontFamily:
            '"Geist", "Avenir Next", "Segoe UI", -apple-system, BlinkMacSystemFont, "Helvetica Neue", Arial, sans-serif',
          primaryColor: "#f0f4ff",
          primaryTextColor: "#111318",
          primaryBorderColor: "#6b93ff",
          secondaryColor: "#f8f9fa",
          tertiaryColor: "#ffffff",
          lineColor: "#6e6e73",
          textColor: "#111318",
          clusterBkg: "#f8f9fa",
          clusterBorder: "#c9ced6",
          edgeLabelBackground: "#ffffff",
        },
      },
    },
  } satisfies Preset.ThemeConfig,
};

export default config;