docusaurus.config.ts

import type { Config, Plugin, PluginConfig, PluginModule } from '@docusaurus/types';
import type { Options } from '@docusaurus/preset-classic';
import { themes } from 'prism-react-renderer';

// src/data/catalogs.json is derived from the docs folder and not tracked in
// git. Writing it here covers every docusaurus command (start, build, serve)
// in one place, before webpack resolves the import. `npm run typecheck` does
// not load this config and has its own hook.
const { generateCatalogs } = require('./scripts/generate-catalogs');
generateCatalogs();

const { parallelSearchParse } = require('./scripts/parallel-search-parse');

const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

const BUILD_TARGET = process.env.BUILD_TARGET ?? 'development';
const isHome = BUILD_TARGET === 'home';
const isDocs = BUILD_TARGET === 'docs';
const docsUrl = 'https://docs.gofiber.io';

function plugins(): PluginConfig[] {
    let pluginList: PluginConfig[] = [
        require.resolve('./no-flash-color-mode-plugin'),

        require.resolve('./simple-analytics-plugin'),

        'docusaurus-plugin-sass',

        // Suppress webpack "Critical dependency" warning from vscode-languageserver-types
        // (transitive dep via mermaid → langium → vscode-languageserver)
        function suppressLangiumWarning(): Plugin {
            return {
                name: 'suppress-langium-warning',
                configureWebpack() {
                    return {
                        ignoreWarnings: [
                            {
                                module: /vscode-languageserver-types/,
                                message: /Critical dependency/,
                            },
                        ],
                    };
                },
            };
        },
    ];
    
    if (isHome) {
        const homeRoot: PluginModule = function homeRoot(_context, _opts) {
            return {
                name: 'home-root',
                async contentLoaded({ actions }) {
                    actions.addRoute({
                        path: '/',
                        component: '@site/src/pages/home', // or .mdx via @theme/MDXPage (see below)
                        exact: true,
                    });
                },
            };
        };
        
        
        return [
            ...pluginList,
            homeRoot,
        ];
    }

    parallelSearchParse();

    return [
        ...pluginList,
        [
            'docusaurus-plugin-llms',
            {
                title: 'Fiber',
                description: 'Fiber is an Express-inspired web framework written in Go.',
                docsDir: 'docs',
                ignoreFiles: ['**/partials/**'],
                excludeImports: true,
                pathTransformation: {
                    // docs/core serves at the site root, the other catalogs at
                    // /<id>; dropping these segments yields the public URLs.
                    ignorePaths: ['docs', 'core'],
                },
            },
        ],
        [require.resolve('@easyops-cn/docusaurus-search-local'),
            {
                hashed: true,
                indexBlog: true,
                docsRouteBasePath: '/',
            },
        ],
        [
            '@docusaurus/plugin-client-redirects',
            {
                redirects: [
                    {
                        from: ['/-middleware', '/middleware'],
                        to: '/category/-middleware',
                    },
                    {
                        from: '/routing',
                        to: '/guide/routing',
                    },
                    {
                        from: '/ctx',
                        to: '/api/ctx',
                    },
                ],
                createRedirects(existingPath: string) {
                    if (existingPath.includes('/v1.x')) {
                        return [existingPath.replace('/v1.x', '/v/1.x')];
                    }
                    // The current docs of contrib/storage/template moved from
                    // /<id>/next/ to /<id>/ (lastVersion: 'current'). Keep old
                    // /next links working. Versioned snapshot paths contain
                    // "_vN.x.x" and are skipped.
                    const multiPkg = existingPath.match(/^\/(contrib|storage|template)(\/.*)?$/);
                    if (multiPkg && !/_v\d+\.x\.x/.test(existingPath)) {
                        return [`/${multiPkg[1]}/next${multiPkg[2] ?? ''}`];
                    }
                    return undefined;
                },
            },
        ],
        [
            '@docusaurus/plugin-pwa',
            {
                debug: false,
                offlineModeActivationStrategies: [
                    'appInstalled',
                    'standalone',
                    'queryString',
                ],
                pwaHead: [{
                    tagName: "link",
                    rel: "icon",
                    href: "img/favicon.png",
                },
                    {
                        tagName: "link",
                        rel: "manifest",
                        href: "manifest.json", // your PWA manifest
                    },
                    {
                        tagName: "meta",
                        name: "theme-color",
                        content: "rgb(0, 172, 215)",
                    },
                ],
            },
        ],
        [
            '@docusaurus/plugin-content-docs',
            ({
                id: 'contrib',
                path: 'docs/contrib',
                routeBasePath: 'contrib',
                editUrl: (params: { docPath: string }) => {
                    return 'https://github.com/gofiber/contrib/edit/main/v3/' + params.docPath;
                },
                editCurrentVersion: true,
                sidebarPath: require.resolve('./default_sidebars'),
                showLastUpdateAuthor: false,
                showLastUpdateTime: true,
                // Serve the up-to-date docs (synced from the repo's main branch) at the
                // unversioned /contrib path instead of an arbitrary release snapshot.
                lastVersion: 'current',
                versions: {
                    current: {
                        label: 'Next',
                    },
                },
            }),
        ],
        [
            '@docusaurus/plugin-content-docs',
            ({
                id: 'storage',
                path: 'docs/storage',
                routeBasePath: 'storage',
                editUrl: (params: { docPath: string }) => {
                    return 'https://github.com/gofiber/storage/edit/main/' + params.docPath;
                },
                editCurrentVersion: true,
                sidebarPath: require.resolve('./default_sidebars'),
                showLastUpdateAuthor: false,
                showLastUpdateTime: true,
                lastVersion: 'current',
                versions: {
                    current: {
                        label: 'Next',
                    },
                },
            }),
        ],
        [
            '@docusaurus/plugin-content-docs',
            ({
                id: 'template',
                path: 'docs/template',
                routeBasePath: 'template',
                editUrl: (params: { docPath: string }) => {
                    return 'https://github.com/gofiber/template/edit/master/' + params.docPath;
                },
                editCurrentVersion: true,
                sidebarPath: require.resolve('./default_sidebars'),
                showLastUpdateAuthor: false,
                showLastUpdateTime: true,
                lastVersion: 'current',
                versions: {
                    current: {
                        label: 'Next',
                    },
                },
            }),
        ],
        [
            '@docusaurus/plugin-content-docs',
            ({
                id: 'recipes',
                path: 'docs/recipes',
                routeBasePath: 'recipes',
                editUrl: (params: { docPath: string }) => {
                    return 'https://github.com/gofiber/recipes/edit/master/' + params.docPath;
                },
                editCurrentVersion: true,
                sidebarPath: require.resolve('./default_sidebars'),
                showLastUpdateAuthor: false,
                showLastUpdateTime: true,
            }),
        ],
    ];
}

function headerNav(): any[] {
    let naviItems: any[] = [
        {
            type: 'doc',
            docId: 'welcome',
            label: '🏠 Home',
            position: 'left',
        },
        {
            type: 'dropdown',
            label: '🧩 Extra',
            position: 'left',
            items: [{
                type: 'docsVersion',
                label: '🧬 Contrib',
                docsPluginId: 'contrib',
            }, {
                type: 'docsVersion',
                label: '📦 Storage',
                docsPluginId: 'storage',
            }, {
                type: 'docsVersion',
                label: '️📄️ Template',
                docsPluginId: 'template',
            }],
        },
        {
            to: 'https://gofiber.io/support',
            label: '☕ Donate',
            position: 'left',
        },
        {
            type: 'docsVersion',
            docsPluginId: 'recipes',
            label: '🍳 Recipes',
            position: 'left',
        },
        {
            to: (isHome ? docsUrl : '') +  '/blog',
            label: '📰 Blog',
            position: 'left',
        },
        {
            to: 'https://github.com/gofiber/awesome-fiber',
            label: '😎 Awesome List',
            position: 'left',
        },
        {
            to: 'https://gofiber.io/discord',
            label: '💬 Chat',
            position: 'left',
        },
        {
            type: 'docsVersionDropdown',
            position: 'right',
            dropdownActiveClassDisabled: true,
            className: 'fiber-versions',
            // dropdownItemsBefore: [{type: 'html', value: '<div class="dropdown__link">Fiber Versions</div>'}],
        },
        {
            type: 'docsVersionDropdown',
            position: 'right',
            dropdownActiveClassDisabled: true,
            docsPluginId: 'contrib',
            className: 'contrib-versions',
            // dropdownItemsBefore: [{type: 'html', value: '<div class="dropdown__link">Contrib Versions</div>'}],
        },
        {
            type: 'docsVersionDropdown',
            position: 'right',
            dropdownActiveClassDisabled: true,
            docsPluginId: 'storage',
            className: 'storage-versions',
            // dropdownItemsBefore: [{type: 'html', value: '<div class="dropdown__link">Storage Versions</div>'}],
        },
        {
            type: 'docsVersionDropdown',
            position: 'right',
            dropdownActiveClassDisabled: true,
            docsPluginId: 'template',
            className: 'template-versions',
            // dropdownItemsBefore: [{type: 'html', value: '<div class="dropdown__link">Template Versions</div>'}],
        },
        {
            type: 'custom-github-stars',
            position: 'right',
        },
        {
            position: 'right',
            className: 'header-github-link',
            'aria-label': 'GitHub Repository',
            items: [
                {
                    label: '🚀 Fiber',
                    href: 'https://github.com/gofiber/fiber',
                },
                {
                    label: '🧬 Contrib',
                    href: 'https://github.com/gofiber/contrib',
                },
                {
                    label: '📦 Storage',
                    href: 'https://github.com/gofiber/storage',
                },
                {
                    label: '📄️ Template',
                    href: 'https://github.com/gofiber/template',
                },
                {
                    label: '🍳️ Recipes',
                    href: 'https://github.com/gofiber/recipes',
                },
            ],
        },
    ];
    
    if (isHome) {
        naviItems[0] = {
            to: docsUrl + '/',
            label: '📚 Docs',
            position: 'left',
            target: '_self',
        };
        
        const switchToLink = (item: any): any => {
            item.to = `${docsUrl}/${item.docsPluginId}`;
            item.target = '_self';
            delete item.docsPluginId;
            delete item.type;
            
            return item;
        }
        // iterate recursively through naviItems and change all items with type 'docsVersion'
        naviItems = naviItems.map((naviItem: any) => {
            if (naviItem?.type === 'dropdown' && naviItem?.items) {
                naviItem.items = naviItem?.items.map((item: any) => {
                    if (item?.type === 'docsVersion') {
                        return switchToLink(item);
                    }
                    return item;
                });
            } else if (naviItem?.type === 'docsVersion') {
                naviItem = switchToLink(naviItem);
            }
            
            return naviItem;
        });
        
        naviItems = naviItems.filter((naviItem: any) => {
            const itemType = naviItem?.type;
            if (typeof itemType === 'string' && itemType.startsWith('custom-')) {
                return true;
            }

            return itemType === undefined || ['dropdown'].includes(itemType);
        })
    }
    
    return naviItems;
}

function preset(): [string, Options] {
    
    if (isHome) {
        return [
            'classic',
            /** @type {import('@docusaurus/preset-classic').Options} */
            ({
                docs: false,
                pages: {include: [], routeBasePath: '/'},
                blog: false,
                theme: {customCss: require.resolve('./src/css/custom.css')},
            }),
        ];
    }
    
    return [
        'classic',
        /** @type {import('@docusaurus/preset-classic').Options} */
        ({
            docs: {
                path: 'docs/core',
                routeBasePath: '/',
                sidebarCollapsed: false,
                sidebarPath: require.resolve('./default_sidebars'),
                // disabled until we make a redirect to the respective source repository
                // editUrl: 'https://github.com/gofiber/fiber/edit/master/',
                editUrl: (params: { docPath: string; version?: string }) => {
                    // console.log(params);
                    if (params.version === 'current') {
                        return 'https://github.com/gofiber/fiber/edit/main/docs/' + params.docPath;
                    }
                    return undefined;
                },
                sidebarItemsGenerator: async function ({defaultSidebarItemsGenerator, ...args}: any) {
                    // filter partials from sidebar
                    return (await defaultSidebarItemsGenerator(args)).filter((item: any) => !(item.label === 'partials' || item.id === 'partials'));
                },
                showLastUpdateAuthor: false,
                showLastUpdateTime: true,
                versions: {
                    current: {
                        label: "Next",
                    },
                },
            },
            pages: {
                path: 'src/pages',
                routeBasePath: '/',
                exclude: isDocs ? ['**/home.{js,jsx,ts,tsx,md,mdx}'] : [],
            },
            blog: {
                showReadingTime: true,
                blogTitle: 'Fiber Blog',
                blogDescription: 'News, guides, and updates around Fiber.',
                blogSidebarCount: 'ALL',
                blogSidebarTitle: 'All posts',
                onInlineTags: 'warn',
                onInlineAuthors: 'warn',
                onUntruncatedBlogPosts: 'warn',
                postsPerPage: 3,
                editUrl: 'https://github.com/gofiber/docs/tree/master/',
            },
            theme: {
                customCss: require.resolve('./src/css/custom.css'),
            },
        }),
    ];
}

const config: Config = {
    title: 'Fiber',
    tagline: 'An online API documentation with examples so you can start building web apps with Fiber right away!',
    url: isHome ? 'https://gofiber.io' : 'https://docs.gofiber.io',
    // url: 'https://gofiber.github.io',
    baseUrl: process.env.BASE_URL || '/',
    onBrokenLinks: 'throw',
    favicon: 'img/favicon.png',
    organizationName: 'gofiber',
    projectName: 'docs',
    future: {
        v4: true,
        faster: true,
    },
    i18n: {
        defaultLocale: 'en',
        locales: ['en'],
    },
    markdown: {
        mermaid: true,
        mdx1Compat: {
            comments: true,
            admonitions: true,
            headingIds: true,
        },
        hooks: {
            onBrokenMarkdownLinks: 'warn',
        },
    },
    plugins: plugins(),

    presets: [
        preset(),
    ],
    themes: ['@inkeep/docusaurus/chatButton', '@docusaurus/theme-mermaid'],

    themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
        ({
            navbar: {
                logo: {
                    alt: 'Fiber Logo',
                    src: 'img/logo.svg',
                    srcDark: 'img/logo-dark.svg',
                    href: isDocs || isHome ? 'https://gofiber.io' : '/',
                    target: '_self',
                },
                items: headerNav(),
            },
            colorMode: {
                respectPrefersColorScheme: true,
            },
            docs: {
                sidebar: {
                    hideable: true,
                    autoCollapseCategories: false,
                },
            },
            announcementBar: {
                id: 'announcement-1',
                content: '🌟 If you like Fiber, don\'t forget to give us a star on <a href="https://github.com/gofiber/fiber">Github</a> 🌟',
                backgroundColor: '#fafbfc',
                textColor: '#091E42',
                isCloseable: true,
            },
            prism: {
                theme: lightCodeTheme,
                darkTheme: darkCodeTheme,
                additionalLanguages: ['diff', 'go', 'json', 'toml', 'yaml'],
            },
            inkeepConfig: {
                chatButtonType: 'PILL', // RECTANGLE_SHORTCUT, ICON, or PILL
                baseSettings: {
                    // see https://docusaurus.io/docs/deployment#using-environment-variables to use docusaurus environment variables
                    apiKey: process.env.INKEEP_API_KEY, // required
                    integrationId: process.env.INKEEP_INTEGRATION_ID, // required
                    organizationId: process.env.INKEEP_ORGANIZATION_ID, // required
                    primaryBrandColor: "#00acd7", // required -- your brand color, the widget color scheme is derived from this
                    organizationDisplayName: "GoFiber",
                    theme: {
                        // stylesheetUrls: ['/path/to/stylesheets'], // optional
                        syntaxHighlighter: {
                            lightTheme: lightCodeTheme, // optional -- pass in the Prism theme you're using
                            darkTheme: darkCodeTheme, // optional -- pass in the Prism theme you're using
                        },
                    },
                },
                aiChatSettings: {
                    chatSubjectName: "Fiber",
                    // optional settings
                    botAvatarSrcUrl: "/img/logo.svg", // optional -- use your own bot avatar
                    botAvatarDarkSrcUrl: "/img/logo-dark.svg", // optional -- use your own bot avatar
                    getHelpCallToActions: [
                        {
                            name: "Discord",
                            url: "https://gofiber.io/discord",
                            icon: {
                                builtIn: "FaDiscord",
                            },
                        },
                        {
                            name: "GitHub",
                            url: "https://github.com/gofiber/fiber",
                            icon: {
                                builtIn: "FaGithub",
                            },
                        },
                    ],
                    quickQuestions: [
                        "How to create custom error handler?",
                        "How can I use live reload?",
                        "Which template engines does Fiber support?",
                    ],
                },
            },
        }),
};

export default config;