docs/docusaurus.config.js at main · epinio/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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const {themes: prismThemes} = require('prism-react-renderer');
const lightCodeTheme = prismThemes.github;
const darkCodeTheme = prismThemes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Epinio docs',
  tagline: 'Epinio - the application development engine for Kubernetes',
  url: 'https://docs.epinio.io',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  favicon: 'img/favicon.png',
  organizationName: 'epinio', // Usually your GitHub org/user name.
  projectName: 'docs', // Usually your repo name.
  trailingSlash: false,

  markdown: {
    // Legacy content (1700+ .md files written pre-MDX-v3) keeps parsing as
    // plain CommonMark; only .mdx files opt in to MDX v3 parsing.
    format: 'detect',
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          editUrl: 'https://github.com/epinio/docs/edit/main',
          routeBasePath: '/',
          sidebarCollapsible: true,
          sidebarCollapsed: true,
          versions: {
            current: {
              label: 'Next 🚧',
            },
          },
        },
        blog: {
          routeBasePath: 'blog',
          path: 'blog',
          blogTitle: 'Epinio Blog',
          blogDescription: "The latest on whats new in Epinio..",
          blogSidebarTitle: 'Blog',
          blogSidebarCount: 'ALL',
          showReadingTime: false,
          feedOptions: {
            type: 'rss',
            title: 'Epinio Blog',
          },
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        // Universal Analytics (UA) - throws "window.ga is not a function" in the
        // dev server because the GA script is not injected there. Re-enable for
        // production, or migrate to GA4 via the `gtag` option with a G- id.
        // googleAnalytics: {
        //   trackingID: 'UA-56382716-12',
        //   anonymizeIP: true,
        // },
      }),
    ],
  ],

  themeConfig:
    /* @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      docs: {
        sidebar: {
          hideable: true,
          autoCollapseCategories: true,
        },
      },
      algolia: {
        appId: 'F9GBZ0DFYI',
        apiKey: 'f53fc15b8c224765ce1c68aa8e8227c9',
        indexName: 'epinio',
        contextualSearch: true,
      },
      navbar: {
        title: 'Epinio',
        logo: {
          alt: 'Epinio',
          src: 'img/favicon.svg',
        },
        items: [
          {
            type: 'docsVersionDropdown',
            position: 'left',
            dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
            dropdownActiveClassDisabled: true,
          },
          {
            to: '/blog',
            label: 'Blog',
            position: 'left',
          },
          {
            type: 'search',
            position: 'left',
          },
          {
            href: 'https://github.com/epinio/epinio',
            position: 'right',
            className: 'header-github-link',
            'aria-label': 'GitHub repository',
          },
          {
            href: 'https://rancher-users.slack.com',
            position: 'right',
            className: 'header-slack-link',
            'aria-label': 'Slack',
          },
        ],
      },
      footer: {
        style: 'dark',
        copyright: `Copyright © ${new Date().getFullYear()} Krumware. All Rights Reserved.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;