docusaurus.config.js

/** @type {import('@docusaurus/types').DocusaurusConfig} */

module.exports = {
    title: 'OpenYurt',
    tagline: 'An open platform that extends upstream Kubernetes to Edge',
    url: 'https://openyurt.io',
    baseUrl: '/',
    onBrokenLinks: 'throw',
    onBrokenMarkdownLinks: 'throw',
    favicon: 'img/openyurt.ico',
    organizationName: 'openyurtio', // Usually your GitHub org/user name.
    projectName: 'openyurt.io', // Usually your repo name.
    i18n: {
        defaultLocale: 'en',
        locales: ['en', 'zh'],
        localeConfigs: {
            en: {
                label: 'English',
            },
            zh: {
                label: '简体中文',
            },
        },
    },
    themeConfig: {
        announcementBar: {
            id: 'start',
            content:
                '⭐️ If you like OpenYurt, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/openyurtio/openyurt">GitHub</a>! ⭐️',
        },
        algolia: {
            apiKey: '636381de756ade28690a2d37b6a9e117',
            indexName: 'openyurt',
        },
        navbar: {
            title: 'OpenYurt',
            logo: {
                alt: 'OpenYurt',
                src: 'img/openyurt.ico',
            },
            items: [
                {
                    type: 'docsVersionDropdown',
                    position: 'right',
                },
                {
                    to: 'docs/',
                    activeBasePath: 'docs',
                    label: 'Documentation',
                    position: 'left',
                },
                {
                    to: 'blog',
                    label: 'Blog',
                    position: 'left'
                },
                {
                    type: 'localeDropdown',
                    position: 'right',
                },
                {
                    href: 'https://github.com/openyurtio/openyurt',
                    className: 'header-github-link',
                    position: 'right',
                },
            ],
        },
        footer: {
            links: [
                {
                    title: 'Documentation',
                    items: [
                        {
                            label: 'Getting Started',
                            to: '/docs/installation/yurtcluster',
                        },
                    ],
                },
                {
                    title: 'Community',
                    items: [
                        {
                            label: 'CNCF Slack ( #openyurt channel )',
                            href: 'https://join.slack.com/t/openyurt/shared_invite/zt-rc5ecz4h-sEWU1vYx5gzc3_zx3En0jg',
                        },
                        {
                            label: 'DingTalk (31993519)',
                            href: '.',
                        },
                        {
                            label: 'Bi-week Meeting (APAC, Chinese)',
                            href: 'https://shimo.im/docs/rGK3cXYWYkPrvWp8',
                        },
                    ],
                },
                {
                    title: 'More',
                    items: [
                        {
                            label: 'GitHub',
                            href: 'https://github.com/openyurtio/openyurt',
                        },
                        {
                            label: 'Community Membership',
                            href: 'https://github.com/openyurtio/community/blob/main/community-membership.md',
                        },
                    ],
                },
            ],
            copyright: `
        <br />
        <strong>Copyright © ${new Date().getFullYear()} The OpenYurt Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/"> Trademark Usage</a> page.</strong
      `,
        },
        prism: {
            theme: require('prism-react-renderer/themes/dracula'),
        },
    },
    presets: [
        [
            '@docusaurus/preset-classic',
            {
                docs: {
                    sidebarPath: require.resolve('./sidebars.js'),
                    editUrl: 'https://github.com/openyurtio/openyurt.io/tree/master',
                    editUrl: function ({
                                           locale,
                                           docPath,
                                       }) {
                        return `https://github.com/openyurtio/openyurt.io/edit/master/docs/${docPath}`;
                    },
                    showLastUpdateAuthor: true,
                    showLastUpdateTime: true,
                    includeCurrentVersion: true,
                },
                blog: {
                    showReadingTime: true,
                    editUrl:
                        'https://github.com/openyurtio/openyurt.io/tree/master/blog',
                    blogSidebarTitle: 'All posts',
                    blogSidebarCount: 'ALL',
                },
                theme: {
                    customCss: require.resolve('./src/css/custom.css'),
                },
            },
        ],
    ],
};