docs/docusaurus.config.ts at main · schedkit/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
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: 'schedkit',
  tagline: 'OCI-packaged sched_ext schedulers, from your laptop to a cluster',
  favicon: 'img/favicon.ico',

  url: 'https://schedkit.io',
  baseUrl: '/',

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

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

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

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

  themeConfig: {
    image: 'img/social-card.png',
    colorMode: {
      defaultMode: 'dark',
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'schedkit',
      logo: {
        alt: 'schedkit',
        src: 'img/logo.svg',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'docsSidebar',
          position: 'left',
          label: 'Docs',
        },
        {
          to: '/docs/schedctl/overview',
          label: 'schedctl',
          position: 'left',
        },
        {
          to: '/docs/sked/overview',
          label: 'sked',
          position: 'left',
        },
        {
          href: 'https://github.com/schedkit',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {label: 'Introduction', to: '/docs/intro'},
            {label: 'schedctl', to: '/docs/schedctl/overview'},
            {label: 'sked', to: '/docs/sked/overview'},
          ],
        },
        {
          title: 'Project',
          items: [
            {label: 'schedctl on GitHub', href: 'https://github.com/schedkit/schedctl'},
            {label: 'sked on GitHub', href: 'https://github.com/schedkit/sked'},
            {label: 'Issues', href: 'https://github.com/schedkit/schedctl/issues'},
          ],
        },
        {
          title: 'Background',
          items: [
            {label: 'sched_ext kernel docs', href: 'https://docs.kernel.org/scheduler/sched-ext.html'},
            {label: 'scx schedulers', href: 'https://github.com/sched-ext/scx'},
            {label: 'OCI image spec', href: 'https://github.com/opencontainers/image-spec'},
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} the schedkit authors. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'yaml', 'toml', 'go', 'docker'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;