docs/docusaurus.config.js at main · mylists/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
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'MTVL Documentation',
  tagline: 'Modular Media & Literature Tracking Platform, API, and Developer Guide',
  favicon: 'img/favicon.ico',

  // Set the production url of your site here
  url: 'https://docs.mylists.cc',
  // Set the /<baseUrl>/ pathname under which your site is served
  baseUrl: '/',

  // GitHub pages deployment config.
  organizationName: 'mylists',
  projectName: 'docs',

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

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

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: './sidebars.js',
          routeBasePath: '/', // Serve docs from the root
          editUrl: 'https://github.com/mylists/docs/tree/main/',
        },
        blog: false, // Optional: disable blog
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      image: 'img/mtvl-social-card.jpg',
      colorMode: {
        defaultMode: 'dark',
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      navbar: {
        title: 'MTVL Docs',
        logo: {
          alt: 'MTVL Logo',
          src: 'img/logo.svg',
        },
        items: [
          {
            type: 'docSidebar',
            sidebarId: 'tutorialSidebar',
            position: 'left',
            label: 'Documentation',
          },
          {
            to: '/api/overview',
            label: 'API Reference',
            position: 'left',
          },
          {
            to: '/developer/architecture',
            label: 'Developer Guide',
            position: 'left',
          },
          {
            to: '/neon/overview',
            label: 'Neon Setup',
            position: 'left',
          },
          {
            href: 'https://github.com/mylists/mtvl',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Documentation',
            items: [
              {
                label: 'Introduction',
                to: '/',
              },
              {
                label: 'App User Guide',
                to: '/app/overview',
              },
              {
                label: 'API Reference',
                to: '/api/overview',
              },
            ],
          },
          {
            title: 'Developers',
            items: [
              {
                label: 'Architecture',
                to: '/developer/architecture',
              },
              {
                label: 'Adding Categories',
                to: '/developer/adding-categories',
              },
              {
                label: 'Neon Postgres Setup',
                to: '/neon/overview',
              },
            ],
          },
          {
            title: 'Ecosystem & Repositories',
            items: [
              {
                label: 'Backend (mtvl)',
                href: 'https://github.com/mylists/mtvl',
              },
              {
                label: 'Frontend (mtvl-frontend)',
                href: 'https://github.com/mylists/mtvl-frontend',
              },
              {
                label: 'Kubernetes Helm Charts',
                href: 'https://github.com/mylists/kubernetes',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} MTVL (mylists). Built with Docusaurus.`,
      },
      prism: {
        theme: require('prism-react-renderer').themes.github,
        darkTheme: require('prism-react-renderer').themes.dracula,
        additionalLanguages: ['bash', 'json', 'go', 'sql', 'yaml', 'docker', 'typescript'],
      },
    }),
};

module.exports = config;