hauler-docs/docusaurus.config.js at main · hauler-dev/hauler-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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
const lightCodeTheme = require('prism-react-renderer').themes.github;
const darkCodeTheme = require('prism-react-renderer').themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Hauler',
  tagline: 'Airgap Swiss Army Knife',
  url: 'https://docs.hauler.dev',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  favicon: 'img/hauler.ico',
  trailingSlash: false,

  organizationName: 'hauler-dev',
  projectName: 'hauler-docs',

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

  markdown: {
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          versions: {
            current: {
              label: 'Next 🚧',
            },
          },

          editUrl: 'https://github.com/hauler-dev/hauler-docs/edit/main/',

        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  plugins: [
    [ require.resolve('docusaurus-lunr-search'),
      {
        languages: ['en'],
        indexBaseUrl: true,
        highlightResult: true
      }
    ],
    [
      require.resolve('@docusaurus/plugin-client-redirects'),
      {
        // The "introduction" section was renamed to "getting-started".
        // For every getting-started page, redirect its old introduction URL.
        // While a released version still serves /docs/introduction/* (e.g. 1.4.x),
        // that redirect collides with a live page and is ignored automatically;
        // it activates once "getting-started" becomes the latest version.
        createRedirects(existingPath) {
          if (existingPath.includes('/getting-started/')) {
            return [existingPath.replace('/getting-started/', '/introduction/')];
          }
          return undefined;
        },
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: 'light',
        disableSwitch: false,
        respectPrefersColorScheme: false,
      },
      metadata: [
        { name: 'keywords', content: 'hauler, dev, airgap, air-gap, docs, documentation' },
        { name: 'description', content: 'Docs for Hauler, An Airgap Swiss-Army Knife provided by Rancher Government' },
      ],
      navbar: {
        title: '',
        logo: {
          alt: 'Carbide Logo',
          src: 'img/rgs-hauler-logo.png',
        },
        items: [
          {
            to: '/docs/intro',
            label: 'Documentation',
            position: 'left'
          },
          {
            type: 'docsVersionDropdown',
            position: 'right',
          },
          {
            href: 'https://github.com/hauler-dev/hauler/issues',
            label: 'Submit an Issue',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Hauler Docs',
                to: '/docs/intro',
              },
              {
                label: 'Quickstart Guide',
                // Resolves to the latest version's quickstart. 2.0.x (getting-started)
                // is now latest; the client-redirects plugin forwards the old
                // /docs/introduction/quickstart URL here automatically.
                to: '/docs/getting-started/quickstart',
              },
              {
                label: 'Reference Guides',
                to: '/docs/guides-references/carbide-customers',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Rancher',
                href: 'https://rancher.com',
              },
              {
                label: 'Rancher GitHub',
                href: 'https://github.com/rancher',
              },
              {
                label: 'Rancher Slack',
                href: 'https://rancher-users.slack.com',
              },
            ],
          },
          {
            title: 'Contact',
            items: [
              {
                label: 'RGS Blog',
                href: 'https://ranchergovernment.com/blog',
              },
              {
                label: 'RGS GitHub',
                href: 'https://github.com/rancherfederal',
              },
              {
                label: 'RGS ZenDesk',
                href: 'https://support.rancherfederal.com',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Rancher Government. All rights reserved.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;