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

const config: Config = {
  title: 'OpenApparatus',
  tagline: 'Reproducible procedural environments for behavioural research',
  favicon: 'img/favicon.svg',

  future: {
    v4: true,
  },

  url: 'https://openapparatus.github.io',
  baseUrl: '/',

  organizationName: 'OpenApparatus',
  projectName: 'docs',
  trailingSlash: false,

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

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

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          routeBasePath: '/',
          editUrl: 'https://github.com/OpenApparatus/docs/tree/main/',
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    colorMode: {
      defaultMode: 'light',
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'OpenApparatus',
      logo: {
        alt: 'OpenApparatus logo',
        src: 'img/logo.svg',
        srcDark: 'img/logo-dark.svg',
      },
      items: [
        {
          type: 'doc',
          docId: 'core/overview',
          position: 'left',
          label: 'Core',
        },
        {
          type: 'doc',
          docId: 'studio/overview',
          position: 'left',
          label: 'Studio',
        },
        {
          type: 'doc',
          docId: 'unity/overview',
          position: 'left',
          label: 'Unity',
        },
        {
          type: 'doc',
          docId: 'design-system/overview',
          position: 'left',
          label: 'Design',
        },
        {
          href: 'https://github.com/OpenApparatus',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {label: 'Introduction', to: '/'},
            {label: 'Getting started', to: '/getting-started'},
            {label: 'Core', to: '/core/overview'},
            {label: 'Studio', to: '/studio/overview'},
            {label: 'Unity', to: '/unity/overview'},
            {label: 'Design system', to: '/design-system/overview'},
          ],
        },
        {
          title: 'Repositories',
          items: [
            {label: 'OpenApparatus/core', href: 'https://github.com/OpenApparatus/core'},
            {label: 'OpenApparatus/studio', href: 'https://github.com/OpenApparatus/studio'},
            {label: 'OpenApparatus/unity', href: 'https://github.com/OpenApparatus/unity'},
          ],
        },
        {
          title: 'More',
          items: [
            {label: 'GitHub organization', href: 'https://github.com/OpenApparatus'},
            {label: 'Contributing', to: '/contributing'},
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} OpenApparatus contributors. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.vsDark,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['csharp', 'json', 'bash', 'powershell'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;