crossplane-provider-docs/docusaurus.config.js at main · SAP/crossplane-provider-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
// @ts-check
// remark-directive is ESM-only; require() returns the module namespace object
const remarkDirective = (() => {
  const m = require('remark-directive');
  return m.default ?? m;
})();
const remarkImageLight = require('./src/plugins/remark-image-light');

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Crossplane Provider Docs',
  tagline: 'Documentation for SAP Crossplane Providers',
  favicon: 'img/co_axolotl.png',

  url: 'https://sap.github.io',
  baseUrl: '/crossplane-provider-docs/',

  organizationName: 'SAP',
  projectName: 'crossplane-provider-docs',

  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',

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

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          path: 'docs',
          routeBasePath: 'docs',
          sidebarPath: require.resolve('./sidebars.js'),
          remarkPlugins: [remarkDirective, remarkImageLight],
          exclude: [
            // exclude everything in the btp submodule except the docs/ subfolder
            'crossplane-provider-btp/!(docs)/**',
            'crossplane-provider-btp/!(docs)',
          ],
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: 'Crossplane Provider Docs',
        logo: {
          alt: 'Crossplane Axolotl Logo',
          src: 'img/co_axolotl.png',
        },
        items: [
          {
            type: 'docSidebar',
            sidebarId: 'mainSidebar',
            position: 'left',
            label: 'Docs',
          },
          {
            href: 'https://github.com/SAP/crossplane-provider-docs',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Contribution',
                to: '/docs/contribution/understand-providers',
              },
              {
                label: 'crossplane-provider-btp',
                to: '/docs/crossplane-provider-btp/docs/user/external-name',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/SAP/crossplane-provider-docs',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} SAP SE or an SAP affiliate company. All rights reserved.`,
      },
      prism: {
        theme: require('prism-react-renderer').themes.github,
        darkTheme: require('prism-react-renderer').themes.dracula,
      },
    }),

  // static/ contains all images for this repo (img/ subfolder)
  // Each submodule's docs/ directory is added so that images in docs/img/ are served at /img/...
  // To add a new submodule, append its docs path, e.g. 'docs/crossplane-provider-xyz/docs'
  staticDirectories: ['static', 'docs/crossplane-provider-btp/docs'],
};

module.exports = config;