jayvee/apps/docs/docusaurus.config.ts at main · jvalue/jayvee · 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
// SPDX-FileCopyrightText: 2025 Friedrich-Alexander-Universitat Erlangen-Nurnberg
//
// SPDX-License-Identifier: AGPL-3.0-only

import type { Options, ThemeConfig } from '@docusaurus/preset-classic';
import type { Config } from '@docusaurus/types';
import { themes as prismThemes } from 'prism-react-renderer';

const config: Config = {
  title: 'Jayvee',
  url: 'https://jvalue.github.io',
  baseUrl: '/jayvee',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: '/img/jayvee.png',
  organizationName: 'jvalue', // Usually your GitHub org/user name.
  projectName: 'jayvee', // Usually your repo name.
  themes: ['@docusaurus/theme-mermaid'],
  markdown: {
    mermaid: true,
  },

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
        },
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Options,
    ],
  ],

  themeConfig: {
    navbar: {
      title: 'Jayvee',
      items: [
        {
          type: 'doc',
          docId: 'user/intro/intro',
          position: 'left',
          label: 'User Docs',
        },
        {
          type: 'doc',
          docId: 'dev/intro',
          position: 'left',
          label: 'Developer Docs',
        },
        {
          type: 'docsVersionDropdown',
          position: 'right',
          dropdownActiveClassDisabled: true,
        },
        {
          href: 'https://github.com/jvalue/jayvee',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub repository',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Learn',
          items: [
            {
              label: 'Installation',
              to: '/docs/user/intro',
            },
            {
              label: 'Core Concepts',
              to: '/docs/user/core-concepts',
            },
            {
              label: 'Examples',
              to: '/docs/user/examples/cars',
            },
            {
              label: 'Start contributing',
              to: '/docs/dev/intro',
            },
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'GitHub',
              href: 'https://github.com/jvalue/jayvee',
            },
            {
              label: 'JValue',
              href: 'https://jvalue.org/',
            },
          ],
        },
        {
          title: 'Legal',
          items: [
            {
              label: 'Imprint',
              href: 'https://jvalue.org/notices/imprint/',
            },
            {
              label: 'Privacy Policy',
              href: 'https://jvalue.org/notices/privacy-policy/',
            },
            {
              label: 'Open Source Notices',
              href: 'https://github.com/jvalue/jayvee/blob/main/NOTICES.md',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Friedrich-Alexander Universität Erlangen-Nürnberg.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies ThemeConfig,

  // Even if you don't use internationalization, you can use this field to set
  // useful metadata like html lang. For example, if your site is Chinese, you
  // may want to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },
};

export default config;