netbird-docs/docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
    title: 'NetBird Documentation',
    tagline: '',
    url: 'https://netbird.io',
    baseUrl: '/docs/',
    onBrokenLinks: 'throw',
    onBrokenMarkdownLinks: 'warn',
    favicon: '/img/favicon.ico',
    organizationName: 'netbirdio',
    projectName: 'netbird',

    presets: [
        [
            'classic',
            ({
                docs: {

                    sidebarPath: require.resolve('./sidebars.js'),
                    routeBasePath: '/',
                    editUrl: 'https://github.com/netbirdio/docs/tree/main',
                    docLayoutComponent: "@theme/DocPage",
                    docItemComponent: "@theme/ApiItem"
                },
                theme: {
                    customCss: require.resolve('./src/css/custom.css'),
                },
                googleAnalytics: {
                    trackingID: 'UA-188381981-2',
                    anonymizeIP: true,
                },
            })
        ],
    ],

    plugins: [
        [
            'docusaurus-plugin-openapi-docs',
            {
                id: "apiDocs",
                docsPluginId: "classic",
                config: {
                    api: {
                        // specPath: "petstore.yaml",
                        specPath: "openapi.yml",
                        // specPath: "https://raw.githubusercontent.com/netbirdio/netbird/main/management/server/http/api/openapi.yml", // Path to designated spec file
                        outputDir: "docs/api", // Output directory for generated .mdx docs
                        sidebarOptions: {
                            groupPathsBy: "tag",
                            categoryLinkSource: "none",
                        },
                    }
                }
            },
        ],
    ],
    themes: ["docusaurus-theme-openapi-docs"], // Allows use of @theme/ApiItem and other components

    themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
        ({
            navbar: {
                title: '',
                logo: {
                    alt: 'netbird Logo',
                    src: '/img/logo.svg',
                    srcDark: '/img/logo-dark.svg',
                    href: '/',
                },
                items: [
                    {
                        to: 'https://netbird.io/',
                        label: 'Home',
                        position: 'right',
                        target: '_self'
                    }, // or position: 'right'
                    {
                        type: 'doc',
                        docId: 'documentation/introduction',
                        position: 'right',
                        label: 'Docs',
                    },
                    {
                        type: 'doc',
                        docId: 'api/netbird-rest-api',
                        // docId: 'api/add-pet',
                        position: 'right',
                        label: 'API',
                    },
                    {
                        to: 'https://netbird.io/blog/',
                        label: 'Blog',
                        position: 'right',
                        target: '_self'
                    },
                    {
                        href: 'https://github.com/netbirdio/netbird',
                        label: 'GitHub',
                        position: 'right',
                    },
                ],
            },
            prism: {
                theme: lightCodeTheme,
                darkTheme: darkCodeTheme,
            },
            announcementBar: {
                id: 'announcementBar-docs',
                content:
                    '⭐ If you like NetBird, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/netbirdio/netbird">GitHub</a></a>',
                backgroundColor: '#e3e3e3',
                textColor: '#091E42',
                isCloseable: true,
            },
            docs: {
                sidebar: {
                    autoCollapseCategories: true
                },
            }
        }),
};

module.exports = config;