docs/docusaurus.config.ts at main · solidtime-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
142
143
144
145
146
147
148
149
150
151
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import type {ScalarOptions} from '@scalar/docusaurus'

const config: Config = {
    title: 'solidtime',
    tagline: 'The modern open-source time-tracker',
    favicon: 'img/favicon.ico',

    plugins: [
        require.resolve('docusaurus-lunr-search'),
        [
            '@scalar/docusaurus', {
            label: 'API',
            route: '/api-reference',
            configuration: {
                spec: {
                    url: 'https://api-docs.solidtime.io/api-docs.json',
                },
                withDefaultFonts: false
            },
        } as ScalarOptions
        ],
        [
            '@docusaurus/plugin-client-redirects',
            {
                redirects: [
                    {
                        from: '/self-hosting/docker',
                        to: '/self-hosting/guides/docker',
                    },
                    {
                        from: '/self-hosting/environments/docker',
                        to: '/self-hosting/guides/docker',
                    },
                    /*
                    {
                        from: '/self-hosting/kubernetes-helm',
                        to: '/self-hosting/guides/kubernetes-helm',
                    },
                    {
                        from: '/self-hosting/environments/kubernetes-helm',
                        to: '/self-hosting/guides/kubernetes-helm',
                    },
                    */
                ],
            }
        ]
    ],

    // Set the production url of your site here
    url: 'https://docs.solidtime.io',
    // Set the /<baseUrl>/ pathname under which your site is served
    // For GitHub pages deployment, it is often '/<projectName>/'
    baseUrl: '/',

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

    // 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'],
    },

    presets: [
        [
            'classic',
            {
                docs: {
                    sidebarPath: './sidebars.ts',
                    routeBasePath: '/',
                },
                blog: false,
                theme: {
                    customCss: './src/css/custom.css',
                },
                sitemap: {
                    changefreq: 'weekly',
                    filename: 'sitemap.xml',
                },
            } satisfies Preset.Options,
        ],
    ],

    themeConfig: {
        image: 'img/og_image.png',
        navbar: {
            logo: {
                alt: 'Site Logo',
                src: 'img/solidtime-logo.svg',
                srcDark: 'img/solidtime-logo-dark-mode.svg',
            },
            items: [
                {
                    type: 'doc',
                    docId: 'user-guide/intro',
                    position: 'left',
                    label: 'User guide',
                },
                {
                    type: 'doc',
                    docId: 'self-hosting/intro',
                    position: 'left',
                    label: 'Self-hosting',
                },
                {
                    type: 'doc',
                    docId: 'development/intro',
                    position: 'left',
                    label: 'Development',
                },
                {
                    href: 'https://www.solidtime.io',
                    label: 'Homepage',
                    position: 'right',
                },
                {
                    href: 'https://github.com/solidtime-io/solidtime',
                    label: 'GitHub',
                    position: 'right',
                },
            ],
        },
        footer: {
            style: 'dark',
            links: [
                {
                    title: 'More',
                    items: [
                        {
                            label: 'GitHub',
                            href: 'https://github.com/solidtime-io/solidtime',
                        },
                    ],
                },
            ],
            copyright: `Copyright © ${new Date().getFullYear()} solidtime.`,
        },
        prism: {
            theme: prismThemes.github,
            darkTheme: prismThemes.dracula,
            additionalLanguages: ['bash'],
        },
    } satisfies Preset.ThemeConfig,
};

export default config;