docs/docusaurus.config.ts at main · miabi-io/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
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import miabiVersions from './src/remark/miabi-versions.mjs';

const config: Config = {
  title: 'Miabi',
  tagline: 'The open-source, self-hosted PaaS for shipping apps, not infrastructure',
  favicon: 'img/favicon.ico',

  future: {
    v4: true,
  },

  url: 'https://docs.miabi.io',
  baseUrl: '/',

  organizationName: 'miabi-io',
  projectName: 'miabi',

  onBrokenLinks: 'warn',

  // Screenshots are added later (see static/img/screenshots/README.md), so a
  // missing image should warn rather than fail the build.
  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownImages: 'warn',
    },
  },

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

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/miabi-io/miabi-docs/tree/main/',
          routeBasePath: 'docs',
          remarkPlugins: [miabiVersions],
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],
  themes: [
    '@docusaurus/theme-mermaid',
    [
      '@easyops-cn/docusaurus-search-local',
      {
        hashed: true, // cache-bust the index when content changes
        indexBlog: false, // blog is disabled above
        docsRouteBasePath: '/docs',
        highlightSearchTermsOnTargetPage: true,
        searchResultLimits: 10,
        explicitSearchResultPath: true,
      },
    ],
  ],

  themeConfig: {
    image: 'img/miabi-social-card.png',
    colorMode: {
      defaultMode: 'dark',
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'Miabi',
      logo: {
        alt: 'Miabi Logo',
        src: 'img/logo.svg',
        srcDark: 'img/logo-white.svg',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'docsSidebar',
          position: 'left',
          label: 'Documentation',
        },
        {
          href: 'https://github.com/miabi-io/miabi',
          label: 'API Reference',
          position: 'left',
        },
        {
          href: 'https://github.com/miabi-io/miabi',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Documentation',
          items: [
            {label: 'Introduction', to: '/docs/getting-started/introduction'},
            {label: 'Installation', to: '/docs/getting-started/installation'},
            {label: 'API Reference', href: 'https://github.com/miabi-io/miabi'},
          ],
        },
        {
          title: 'Features',
          items: [
            {label: 'Applications', to: '/docs/applications/overview'},
            {label: 'Domains & TLS', to: '/docs/networking/domains'},
            {label: 'Databases', to: '/docs/databases/overview'},
            {label: 'Marketplace', to: '/docs/marketplace/overview'},
          ],
        },
        {
          title: 'Ecosystem',
          items: [
            {label: 'GitHub', href: 'https://github.com/miabi-io/miabi'},
            {label: 'Goma Gateway', href: 'https://github.com/jkaninda/goma-gateway'},
            {label: 'Posta', href: 'https://github.com/goposta/posta'},
            {label: 'Okapi', href: 'https://github.com/jkaninda/okapi'},
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Jonas Kaninda. Community edition licensed under AGPL-3.0-or-later.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'json', 'go', 'yaml', 'toml', 'docker'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;