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: 'Serenity BDD Users Manual',
  tagline: 'Automated Acceptance Testing With Style',
  url: 'https://serenity-bdd.github.io',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  trailingSlash: false,
  organizationName: 'serenity-bdd', // Usually your GitHub org/user name.
  projectName: 'serenity-bdd.github.io', // Usually your repo name.
  // NB: We need to set the env variable DEPLOYMENT_BRANCH to gh-pages

  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          editUrl: 'https://github.com/serenity-bdd/documentation',
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          editUrl:
            'https://serenity-bdd.github.io/blog',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: 'Home',
        logo: {
          alt: 'Serenity BDD Logo',
          src: 'img/serenity-bdd-small.png',
        },
        items: [
          {
            type: 'doc',
            docId: 'tutorials/first_test',
            position: 'left',
            label: 'Tutorials',
          },
          {
            type: 'doc',
            docId: 'guide/user_guide_intro',
            position: 'left',
            label: 'User Manual',
          },
          {to: 'blog', label: 'Blog', position: 'left'},
          {
            href: 'https://johnfergusonsmart.com/serenity-bdd-mentoring/',
            label: 'Get Support',
            position: 'right',
          },
          {
            href: 'https://expansion.serenity-dojo.com/courses/testing-web-applications-with-serenity-bdd',
            label: 'Learn Serenity BDD Online',
            position: 'right',
          },
          {
            href: 'https://www.serenity-dojo.com/',
            label: 'BDD And Test Automation Coaching',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Tutorial',
                to: 'docs/tutorials/first_test',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Gitter',
                href: 'https://gitter.im/serenity-bdd/serenity-core',
              },
              {
                label: 'Stack Overflow',
                href: 'https://stackoverflow.com/questions/tagged/serenity-bdd',
              }
            ],
          },
          {
            title: 'Learn Serenity BDD',
            items: [
              {
                label: 'The Serenity Dojo Training Library',
                href: 'http://expansion.serenity-dojo.com',
              },
              {
                label: 'Personalised Serenity BDD Coaching',
                href: 'https://www.serenity-dojo.com/apply',
              }
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'Blog',
                to: '/blog',
              },
              {
                label: 'GitHub',
                href: 'https://github.com/serenity-bdd/serenity-core',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Serenity Dojo Ltd.`,
      },
      prism: {
        additionalLanguages: ['java', 'groovy'],
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;