docs/docusaurus.config.js

/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const path = require('path');
const versions = require('./versions.json');
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
    title: 'Dinky',  //&#32593;&#31449;&#26631;&#39064; | Site title
    tagline: 'Dinky &#20026; Apache Flink &#32780;&#29983;&#65292;&#35753; Flink SQL &#32437;&#20139;&#19997;&#28369;', // &#32593;&#31449;&#26631;&#35821; | Tagline for your website
    url: 'https://www.dinky.org.cn/', // &#32593;&#31449;&#32593;&#22336; | Your website's URL
    baseUrl: '/', // &#31449;&#28857;&#30340;&#30456;&#23545;&#36335;&#24452; &#21487;&#23558;&#20854;&#35270;&#20026;&#26159;&#20027;&#26426;&#21517;&#21518;&#30340;&#36335;&#24452; | Path to your website
    staticDirectories: ['static/img', 'blog/blog_img'], // &#38745;&#24577;&#25991;&#20214;&#30446;&#24405; | Path to static files
    // trailingSlash: true, //&#27492;&#36873;&#39033;&#20801;&#35768;&#24744;&#33258;&#23450;&#20041; URL/&#38142;&#25509;&#21518;&#26159;&#21542;&#28155;&#21152;&#32467;&#23614;&#26012;&#26464; | Whether to append a trailing slash to the URL when rendering URLs
    onBrokenLinks: 'ignore', // Docusaurus &#22312;&#26816;&#27979;&#21040;&#26080;&#25928;&#38142;&#25509;&#26102;&#30340;&#34892;&#20026; |  Docusaurus behavior when invalid links are detected    -> &#31867;&#22411;&#65306;'ignore' | 'log' | 'warn' | 'error' | 'throw' |
    onBrokenMarkdownLinks: 'warn', // Docusaurus &#22312;&#26816;&#27979;&#21040;&#26080;&#25928; Markdown &#38142;&#25509;&#26102;&#30340;&#34892;&#20026; | Docusaurus behavior when detecting invalid markdown links  -> &#31867;&#22411;&#65306;'ignore' | 'log' | 'warn' | 'error' | 'throw'
    onDuplicateRoutes: 'warn', // Docusaurus &#22312;&#26816;&#27979;&#21040;&#37325;&#22797;&#30340;&#36335;&#30001;&#26102;&#30340;&#34892;&#20026; |  Behavior of docusaurus when duplicate routes are detected  ->  &#31867;&#22411;&#65306;'ignore' | 'log' | 'warn' | 'error' | 'throw'
    favicon: 'dinky_logo.svg', // &#24038;&#20391;logo  | left logo
    organizationName: 'DataLinkDC', // &#25317;&#26377;&#27492;&#28304;&#30340; GitHub &#29992;&#25143;&#25110;&#32452;&#32455;&#12290; &#29992;&#20110;&#37096;&#32626;&#21629;&#20196;&#12290; |  The GitHub user or organization that owns this source. Command for deployment.
    projectName: 'dinky', // GitHub &#28304;&#30340;&#21517;&#31216;&#12290; &#29992;&#20110;&#37096;&#32626;&#21629;&#20196;&#12290; | The name of the GitHub repository. Command for deployment.
    deploymentBranch: 'main', // GitHub Pages &#30340;&#37096;&#32626;&#20998;&#25903;&#12290; &#29992;&#20110;&#37096;&#32626;&#21629;&#20196;&#12290; | The branch to deploy to GitHub Pages. Command for deployment.
    customFields: { // &#33258;&#23450;&#20041;&#23383;&#27573; | Custom fields
        structTitle: 'Dinky',
        structSubTitle: 'Dinky &#20026; Apache Flink &#32780;&#29983;&#65292;&#35753; Flink SQL &#32437;&#20139;&#19997;&#28369;',
        // structDescription: custom_fields.structDesc(),
        learningMore: 'https://space.bilibili.com/366484959/video',
        teaching: 'https://www.bilibili.com/video/BV1SX4y1Y7CB/?spm_id_from=333.337.search-card.all.click&vd_source=e806cc3d8e01f5e39a97787aca3fa3ae'
    },
    i18n: {
        defaultLocale: 'zh',
        locales: ['zh'],
        path: "i18n",
        localeConfigs: {
            'zh': {
                label: "&#20013;&#25991;",
                direction: 'ltr',
            },
            'en': {
                label: "English",
                direction: 'ltr',
            },
        },
    },
    themes: [
        [
            require.resolve("@easyops-cn/docusaurus-search-local"),
            /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
            ({
                // config url is: https://github.com/easyops-cn/docusaurus-search-local#theme-options
                hashed: true,
                indexDocs: true,
                indexPages: true,
                highlightSearchTermsOnTargetPage: false, // Highlight search terms on target page.
                explicitSearchResultPath: true,
                searchBarPosition: "right",
                language: ["zh", "en"],
                hideSearchBarWithNoSearchContext: true,
            }),
        ],
    ],
    presets: [
        [
            '@docusaurus/preset-classic',
            /** @type {import('@docusaurus/preset-classic').Options} */
            ({
                docs: {
                    includeCurrentVersion: true,
                    lastVersion: '1.1',
                    versions: {
                        current: {
                            label: 'Dev',
                            path: '/next',
                            banner: 'unreleased',
                        },
                        '1.1': {
                            label: '1.1',
                            path: '/1.1',
                        },
                        '1.0': {
                            label: '1.0',
                            path: '/1.0',
                        },
                        0.7: {
                            label: '0.7',
                            path: '/0.7',
                            banner: 'unmaintained',
                        },
                        0.6: {
                            label: '0.6',
                            path: '/0.6',
                            banner: 'unmaintained',
                        },
                    },
                    sidebarPath: require.resolve('./sidebars.js'),
                    sidebarCollapsible: true,
                    // Please change this to your repo.
                    editUrl: ({locale, versionDocsDirPath, docPath}) => {
                        if (locale !== 'zh') {
                            return `https://github.com/DataLinkDC/dinky/tree/master/docs/i18n/${locale}/${docPath}`;
                        }
                        return `https://github.com/DataLinkDC/dinky/tree/master/docs/${versionDocsDirPath}/${docPath}`;
                    },
                },
                blog: {
                    showReadingTime: true, // &#23637;&#31034;&#38405;&#35835;&#26102;&#38388; | show read time
                    include: ['**/*.{md,mdx}'],
                    exclude: [
                        '**/_*.{js,jsx,ts,tsx,md,mdx}',
                        '**/_*/**',
                        '**/*.test.{js,jsx,ts,tsx}',
                        '**/__tests__/**',
                    ],
                    sortPosts: "descending", // &#21338;&#23458;&#20027;&#39029;&#20998;&#39029;&#30340;&#25490;&#24207;&#35268;&#21017;(&#20250;&#26681;&#25454;&#26102;&#38388;&#25490;&#24207;) &#38477;&#24207;: 'descending'  &#21319;&#24207;: 'ascending' | Governs the direction of blog post sorting.
                    postsPerPage: 20, // &#21338;&#23458;&#20027;&#39029;&#30340;&#21069;{count}&#31687;&#25991;&#31456;&#25968; | the blog homepage show limit count
                    readingTime: ({content, frontMatter, defaultReadingTime}) =>
                        defaultReadingTime({content, options: {wordsPerMinute: 300}}), // &#38405;&#35835;&#26102;&#38388; md&#25991;&#20214;&#20013;&#22914;&#26524;&#19981;&#20889; date: &#27492;&#23646;&#24615; &#40664;&#35748;&#26159;&#24403;&#21069;&#26102;&#38388;
                },
                theme: {
                    customCss: require.resolve('./src/css/custom.css'), // &#33258;&#23450;&#20041;css&#25991;&#20214;
                },
            }),
        ],
    ],

    themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
        ({
            // announcementBar: {
            //     id: 'announcementBar-2', // Increment on change
            //     content: `&#11088;&#65039; &nbsp; If you like Dinky , give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/DataLinkDC/dinky">GitHub</a> . Domain name will be migrated soon , The new domain name is  <a target="_blank" rel="noopener noreferrer" href="https://www.dinky.org.cn">www.dinky.org.cn</a>`,
            //     backgroundColor: "#BBDFFF",
            //     isCloseable: false,
            // },
            hideOnScroll: false, // &#28378;&#21160;&#26102;&#26159;&#21542;&#38544;&#34255; | Whether to hide the sidebar on scroll
            docs: {
                sidebar: {
                    hideable: true,// &#26159;&#21542;&#38544;&#34255;&#20391;&#36793;&#26639; | Whether to hide the sidebar in mobile
                    autoCollapseCategories: false, // &#28857;&#20987;&#21478;&#19968;&#20010;&#20998;&#31867;&#26102;&#33258;&#21160;&#25240;&#21472;&#24403;&#21069;&#20998;&#31867; | Click another category will automatically collapse the current category

                }
            },
            navbar: {
                title: 'Dinky',
                logo: {
                    alt: 'Dinky',
                    src: 'side_dinky.svg',
                },
                items: [
                    {
                        to: '/',
                        position: 'left',
                        label: 'home',
                        activeBaseRegex: `^/$`,
                    },
                    {
                        type: 'docsVersionDropdown',
                        position: 'left',
                        dropdownActiveClassDisabled: true,
                    },
                    {
                        to: '/download/download',
                        position: 'right',
                        label: 'download',
                        activeBaseRegex: `/download/`,
                    },
                    {
                        label: 'developer_guide',
                        to: '/docs/next/developer_guide/contribution/how_contribute',
                        position: 'right',
                        items: [
                            {
                                label: "how_contribute",
                                to: "/docs/next/developer_guide/contribution/how_contribute",
                            },
                            {
                                label: "local_debug",
                                to: "/docs/next/developer_guide/local_debug",
                            },
                        ],
                    },
                    // {
                    //     to: '/blog',
                    //     position: 'right',
                    //     label: 'bolg',
                    //     // activeBaseRegex: `/*/`,
                    // },
                    {
                        type: 'localeDropdown',
                        position: 'right',
                    },
                    {
                        href: 'https://github.com/DataLinkDC/dinky/issues/884',
                        label: 'faq',
                        position: 'right',
                    },
                    {
                        href: 'https://github.com/orgs/DataLinkDC/projects/1',
                        label: 'roadmap',
                        position: 'right',
                    },
                    {
                        href: 'https://github.com/DataLinkDC/dinky',
                        className: 'header-github-link',
                        position: 'right',
                        alt: 'Gitlab repository',
                    },
                ],
            },
            footer: {
                style: 'dark',
                links: [
                    {
                        title: 'docs',
                        items: [
                            {
                                label: 'doc_home',
                                to: '/docs/next/get_started/overview',
                            },
                            {
                                label: 'openapi',
                                to: '/docs/next/openapi/openapi_overview',
                            },
                        ],
                    },
                    {
                        title: 'community',
                        items: [
                            {
                                label: 'issue',
                                href: 'https://github.com/DataLinkDC/dinky/issues',
                            },
                            {
                                label: 'pr',
                                href: 'https://github.com/DataLinkDC/dinky/pulls',
                            },
                        ],
                    },
                    {
                        title: 'more',
                        items: [
                            {
                                label: 'github',
                                href: 'https://github.com/DataLinkDC/dinky',
                            }
                        ],
                    },
                ],
                logo: {
                    alt: 'Dinky',
                    src: 'side_dinky.svg',
                    width: 100,
                    height: 30,
                },
                copyright: `Copyright &copy; ${new Date().getFullYear()} Dinky, Inc. DataLinkDC.<br/>
                    <a href="https://beian.miit.gov.cn" target="_blank">&#40065;ICP&#22791;20001630&#21495;-3</a>`,
            },
            prism: {
                theme: lightCodeTheme,
                darkTheme: darkCodeTheme,
            },
        }),
    plugins: [
        './src/plugin/wwads-plugin.ts',
        'docusaurus-plugin-less',
        [
            '@docusaurus/plugin-content-docs',
            {
                id: 'download',
                path: 'download',
                routeBasePath: 'download',
                editUrl: ({locale, versionDocsDirPath, docPath}) => {
                    if (locale !== 'zh') {
                        return `https://github.com/DataLinkDC/dinky/tree/master/docs/i18n/${locale}/${docPath}`;
                    }
                    return `https://github.com/DataLinkDC/dinky/tree/master/docs/${versionDocsDirPath}/${docPath}`;
                },
                sidebarPath: require.resolve('./sidebars.js'),
            },
        ],
        [
            '@docusaurus/plugin-ideal-image',
            {
                quality: 70,
                max: 1030, // &#26368;&#22823;&#32553;&#25918;&#22270;&#29255;&#23610;&#23544;&#12290;
                options: {
                    // &#22270;&#29255;&#21152;&#36733;&#22833;&#36133;&#26102;&#26174;&#31034;&#30340;&#22270;&#29255;
                    // &#40664;&#35748;&#30340;&#22270;&#29255;&#21152;&#36733;&#26041;&#24335;
                    // &#40664;&#35748;&#30340;&#22270;&#29255;&#21152;&#36733;&#26041;&#24335;
                    loadType: 'default',
                    // &#22270;&#29255;&#21152;&#36733;&#22833;&#36133;&#26102;&#26174;&#31034;&#30340;&#22270;&#29255;
                    errorImg: 'Cannot load image',
                    // &#22270;&#29255;&#21152;&#36733;&#22833;&#36133;&#26102;&#26174;&#31034;&#30340;&#22270;&#29255;
                    errorType: 'default',
                    // &#22270;&#29255;&#21152;&#36733;&#22833;&#36133;&#26102;&#26174;&#31034;&#30340;&#22270;&#29255;
                    errorImgType: 'default',
                    // &#22270;&#29255;&#21152;&#36733;&#22833;&#36133;&#26102;&#26174;&#31034;&#30340;&#22270;&#29255;
                },
                min: 640, // &#26368;&#23567;&#32553;&#25918;&#22270;&#29255;&#23610;&#23544;&#12290; &#22914;&#26524;&#21407;&#22987;&#20540;&#27604;&#36825;&#36824;&#20302;&#65292;&#20250;&#20351;&#29992;&#21407;&#22270;&#23610;&#23544;&#12290;
                steps: 2, // &#22312; min &#21644; max &#20043;&#38388;&#26368;&#22810;&#29983;&#25104;&#30340;&#22270;&#29255;&#25968;&#37327;&#65288;&#21253;&#21547;&#20004;&#31471;&#28857;&#65289;
                disableInDev: false,
            },
        ]
    ],
    scripts: [
        // &#32479;&#35745; pv
        {src: 'https://hm.baidu.com/hm.js?7f2b5e6f354b8ae1cdec43ba108936f7', async: true},
        {src: 'https://cdn.wwads.cn/js/makemoney.js', async: true},
    ]
};

module.exports = config;