gnosis_vpn-docs/docusaurus.config.js at main · gnosis/gnosis_vpn-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
// @ts-check
const { themes } = require("prism-react-renderer");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Gnosis VPN",
  tagline: "Privacy-focused VPN built on the HOPR mixnet",
  favicon: "img/favicon.ico",

  // Set these to your real deployment URL when you have one.
  url: "https://docs.vpn.gnosis.eth.limo",
  baseUrl: "/",

  // IMPORTANT for IPFS gateway routing.
  trailingSlash: true,

  markdown: {
    hooks: {
      onBrokenMarkdownLinks: "warn",
    },
  },
  onBrokenLinks: "warn",

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

  // Load the Tabler icon webfont (used by the category cards).
  stylesheets: [
    "https://cdn.jsdelivr.net/npm/@tabler/icons-webfont@3.0.0/dist/tabler-icons.min.css",
  ],
  headTags: [
    {
      tagName: "link",
      attributes: {
        rel: "llms",
        href: "https://raw.githubusercontent.com/gnosis/gnosis_vpn-docs/refs/heads/main/static/llms.txt",
        type: "text/markdown",
      },
    },
    {
      tagName: "meta",
      attributes: {
        name: "google-site-verification",
        content: "ZCsofUSc0BNyfcE2zikbCS7MqgyZ88s6062MXHzfrNs",
      },
    },
  ],
  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          routeBasePath: "docs",
          editUrl: undefined,
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        // Logo is white/pale-yellow, built for the dark navbar.
        // Keep light as default; navbar stays dark in both modes via CSS.
        defaultMode: "light",
        respectPrefersColorScheme: true,
      },
      navbar: {
        // Title empty: the logo SVG already contains the wordmark.
        title: "",
        logo: {
          alt: "Gnosis VPN",
          src: "img/gnosis_vpn.svg",
          href: "/",
        },
        items: [
          {
            href: "https://raw.githubusercontent.com/gnosis/gnosis_vpn-docs/refs/heads/main/static/llms.txt",
            label: "For AI assistants: llms.txt",
            position: "right",
          },
          {
            href: "https://github.com/gnosis/gnosis_vpn",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Docs",
            items: [
              { label: "Introduction", to: "/docs/introduction/overview" },
              { label: "Get started", to: "/docs/get-started/requirements" },
              { label: "Troubleshooting", to: "/docs/troubleshooting/logs" },
            ],
          },
          {
            title: "Community",
            items: [
              {
                label: "GitHub Discussions",
                href: "https://github.com/gnosis/gnosis_vpn/discussions",
              },
            ],
          },
          {
            title: "More",
            items: [
              {
                label: "Onboarding tool",
                href: "https://self-onboarding.gnosisvpn.com",
              },
              {
                label: "Downloads",
                href: "https://downloads.vpn.gnosis.eth.limo",
              },
            ],
          },
        ],
        copyright: `Gnosis VPN — El Dorado.`,
      },
      prism: {
        theme: themes.github,
        darkTheme: themes.dracula,
      },
    }),
};

module.exports = config;