docs/docusaurus.config.js at main · shiHongxing/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
const path = require("path");

module.exports = {
    title: "Starwhale",
    tagline: "An MLOps Platform",
    url: "https://doc.starwhale.ai",
    baseUrl: "/",
    onBrokenLinks: "warn",
    onBrokenMarkdownLinks: "warn",
    favicon: "img/favicon.ico",
    organizationName: "doc.starwhale.ai",
    projectName: "starwhale",

    i18n: {
        defaultLocale: 'en',
        locales: ['en', 'zh'],
        localeConfigs: {
            en: {
                label: 'English',
                direction: 'ltr',
                htmlLang: 'en-US',
                calendar: 'gregory',
            },
        },
    },

    themeConfig: {
        prism: {
            theme: require("prism-react-renderer/themes/dracula"),
            darkTheme: require("prism-react-renderer/themes/duotoneDark"),
        },
        colorMode: {
            defaultMode: 'light',
            disableSwitch: false,
            respectPrefersColorScheme: false,
        },
        zoomSelector: ".markdown :not(em) > img",
        announcementBar: {
            id: "supportus",
            content:
                'If you like <b>Starwhale</b>, <a target="_blank" rel="noopener noreferrer" href="https://github.com/star-whale/starwhale">give us a star on GitHub!</a> 🌺',
            isCloseable: true,
        },
        navbar: {
            style: "dark",
            hideOnScroll: true,
            title: " ",
            logo: {
                alt: "Starwhale",
                src: "img/starwhale-white.png",
                href: "/docs/",
            },
            items: [
                {
                    type: "docsVersionDropdown",
                    position: "right",
                    dropdownActiveClassDisabled: true,
                },
                {
                    to: "https://github.com/star-whale/starwhale",
                    position: "right",
                    className: "header-ico header-ico--github",
                    "aria-label": "GitHub repository",
                    label: "Github",
                },
                {
                    to: "https://starwhale.slack.com",
                    position: "right",
                    className: "header-ico header-ico--slack",
                    "aria-label": "Slack Channel",
                    label: "Slack",
                },
                {
                    type: 'localeDropdown',
                    position: 'right',
                },
            ],
        },
        footer: {
            style: "light",
            copyright: `Copyright © ${new Date().getFullYear()} Starwhale, Inc. All rights reserved. `,

            links: [],
        },
        custom: {
            footerSocials: [],
        },
    },
    customFields: {
        email: "developer@starwhale.ai",
        description:
            "Starwhale is an MLOps platform to manage machine learning projects, models and datasets.",
    },
    presets: [
        [
            "@docusaurus/preset-classic",
            {
                docs: {
                    sidebarPath: require.resolve("./sidebars.js"),
                    editUrl: "https://github.com/star-whale/docs/tree/main",
                    versions: {
                        current: {
                            label: "WIP",
                            badge: true,
                            banner: "unreleased",
                            path: "/next",
                        }
                    }
                },
                theme: {
                    customCss: require.resolve("./src/css/custom.scss"),
                },
                gtag: {
                    trackingID: "none",
                    anonymizeIP: true,
                },
            },
        ],
    ],
    plugins: [
        "docusaurus-plugin-sass",
        path.resolve(__dirname, "src/zoom-plugin"),
    ],
};