docusaurus.config.js

// GitHub Settings
const vars = require('./variables')

// enable or disable the announcement header bar (see 'announcementBar' section below)
const isAnnouncementActive = false;


// Docusaurus Config
module.exports = {
  title: "Cardano Developer Portal",
  tagline: "Let’s build together",
  url: "https://developers.cardano.org",
  baseUrl: "/",
  onBrokenLinks: "warn",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon.ico",
  organizationName: "cardano-foundation",
  projectName: "developer-portal",
  customFields: {
    repository: `${vars.repository}`,
    branch: `${vars.branch}`,
  },
  themeConfig: {
    // Docs Sidebar
    docs: {
      sidebar: {
        hideable: true,
      }
    },

    // Additional Language Syntax Highlighting
    prism: {
      additionalLanguages: ['csharp', 'php'],
    },

    // Announcement Bar
    // id: always change it when changing the announcement
    // backgroundColor: use #FD7575 for warnings and #2AA18A for announcements
    announcementBar: isAnnouncementActive ?{
      id: "announcement_index5", // Any value that will identify this message + increment the number every time to be unique
      content:
        `<strong>Calling all Cardano developers! Your experience matters, take the annual <a target="_blank" rel="noopener noreferrer" href="https://cardanofoundation.outgrow.us/cardano-developer-ecosystem-survey-2024">Developer Ecosystem Survey</a> ⭐️</strong>`,
      backgroundColor: "#2AA18A",
      textColor: "#FFFFFF", // Use #FFFFFF
      isCloseable: true, // Use true
    }: undefined,

    // Meta Image that will be used for your meta tag, in particular og:image and twitter:image
    // Relative to your site's "static" directory, cannot be SVGs.
    image: "img/og/og-developer-portal.png",
    metadata: [{ name: "twitter:card", content: "summary" }],

    // Algolia Search
    algolia: {
      appId: "6QH8YVQXAE",
      apiKey: "6033c09f3af6454c8c25efce0460b84a",
      indexName: "developer-portal",
      contextualSearch: true,
    },

    // Navbar title, logo and items
    navbar: {
      hideOnScroll: false,
      title: "Developers",
      logo: {
        alt: "Cardano Logo",
        src: "img/cardano-black.svg",
        srcDark: "img/cardano-white.svg",
      },

      items: [
        {
          to: "docs/get-started/",
          label: "Get Started",
          position: "left",
        },
        {
          to: "tools",
          label: "Builder Tools",
          position: "left",
        },
        {
          to: "showcase",
          label: "Showcase",
          position: "left",
        },
        {
          to: "blog/",
          label: "Dev Blog",
          position: "left",
        },
        {
          href: "https://docs.cardano.org/en/latest/",
          label: "Docs",
          position: "left",
        },
        {
          href: `${vars.repository}`,
          position: "right",
          className: "header-github-link",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Developer Portal",
          items: [
            {
              label: "Contributors",
              to: "docs/portal-contributors/",
            },
            {
              label: "Changelog",
              to: "/changelog",
            },
            {
              label: "How to Contribute",
              to: "docs/portal-contribute/",
            },
            {
              label: "Style Guide",
              to: "docs/portal-style-guide",
            },
            {
              label: "Suggest Content",
              href: "https://github.com/cardano-foundation/developer-portal/discussions/161",
            },
            {
              label: "Raise an Issue",
              href: "https://github.com/cardano-foundation/developer-portal/issues",
            },
          ],
        },
        {
          title: "Developer Community",
          items: [
            {
              label: "Stack Exchange",
              href: "https://cardano.stackexchange.com",
            },
            {
              label: "Cardano Forum",
              href: "https://forum.cardano.org/c/developers/29",
            },
            {
              label: "Developer Portal Discord",
              href: "https://discord.com/invite/Exe6XmqKDx",
            },
            {
              label: "Developer Ecosystem Survey",
              href: "https://cardano-foundation.github.io/state-of-the-developer-ecosystem",
            },
            {
              label: "More",
              to: "docs/get-started/cardano-developer-community",
            },
          ],
        },
        {
          title: "More about Cardano",
          items: [
            {
              label: "Careers on Cardano",
              to: "docs/careers",
            },
            {
              label: "Cardano Enterprise",
              href: "https://cardano.org/enterprise",
            },
            {
              label: "Cardano Foundation",
              href: "https://www.cardanofoundation.org",
            },
            {
              label: "Development Updates",
              href: "https://cardanoupdates.com",
            },
            {
              label: "Ouroboros Protocol",
              href: "https://cardano.org/ouroboros/",
            },
          ],
        },
      ],

      // Let's use the copyright footer for terms and privacy policy for now
      copyright: `<a href="https://cardanofoundation.org/en/terms-and-conditions" target="_blank" rel="noopener noreferrer" style="color: #ebedf0;">Terms</a> | <a href="https://cardanofoundation.org/en/privacy" target="_blank" rel="noopener noreferrer" style="color: #ebedf0;">Privacy Policy</a>`,
    },
  },
  plugins: [
    [
      "@docusaurus/plugin-ideal-image",
      {
        quality: 70,
        max: 1030, // max resized image's size.
        min: 640, // min resized image's size. if original is lower, use that size.
        steps: 2, // the max number of images generated between min and max (inclusive)
      },
    ],
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            // redirect the old smart contracts signpost to the new smart contract category
            to: '/docs/smart-contracts/',
            from: '/docs/get-started/smart-contracts-signpost',
          },
          {
            // redirect the old funding category overview to the new governance category
            to: '/docs/governance/',
            from: '/docs/fund-your-project/',
          },
          {
            // redirect to the new catalyst page
            to: '/docs/governance/project-catalyst',
            from: ['/docs/fund-your-project/project-catalyst', '/docs/fund-your-project/alternatives']
          },
          {
            // redirect the old cardano improvement proposal overview
            to: '/docs/governance/cardano-improvement-proposals/CIP-0001',
            from: '/docs/governance/cardano-improvement-proposals/',
          },
          {
            // redirect as many pages as possible from old SPO course to new SPO course
            // (any old page not existing on new course, include in redirection to top level)
            to: '/docs/operate-a-stake-pool/',
            from: [ 
                    '/docs/stake-pool-course/',
                    '/docs/stake-pool-course/lesson-1',
                    '/docs/stake-pool-course/lesson-2',
                    '/docs/stake-pool-course/lesson-3',
                    '/docs/stake-pool-course/lesson-4',
                    '/docs/stake-pool-course/lesson-5',
                    '/docs/stake-pool-course/handbook/setup-virtual-box-written',
                    '/docs/stake-pool-course/handbook/setup-a-server-on-aws-written',
                    '/docs/stake-pool-course/assignments/assignment-1',
                    '/docs/stake-pool-course/assignments/assignment-2',
                    '/docs/stake-pool-course/assignments/kes_period'
                  ]
          },
          {
            to: '/docs/operate-a-stake-pool/introduction-to-cardano/',
            from: '/docs/stake-pool-course/introduction-to-cardano',
          },
          {

            to: '/docs/operate-a-stake-pool/grafana-dashboard-tutorial/',
            from: [ 
                    '/docs/stake-pool-course/handbook/grafana-dashboard-tutorial',
                    '/docs/stake-pool-course/handbook/grafana-loki',
                    '/docs/stake-pool-course/handbook/apply-logging-prometheus',
                  ]
          },
          {
            to: '/docs/operate-a-stake-pool/hardening-server/',
            from: '/docs/stake-pool-course/handbook/setup-firewall',
          },
          {
            to: '/docs/operate-a-stake-pool/node-installation-process/',
            from: '/docs/stake-pool-course/handbook/install-cardano-node-written',
          },
          {
            to: '/docs/get-started/cardano-node/running-cardano/',
            from: '/docs/stake-pool-course/handbook/run-cardano-node-handbook',
          },
          {
            to: '/docs/get-started/create-simple-transaction/',
            from: [ 
                    '/docs/stake-pool-course/handbook/use-cli',
                    '/docs/stake-pool-course/handbook/create-simple-transaction',
                  ]
          },
          {
            to: '/docs/get-started/technical-concepts/',
            from: '/docs/stake-pool-course/handbook/utxo-model',
          },
          {
            to: '/docs/operate-a-stake-pool/cardano-key-pairs/',
            from: '/docs/stake-pool-course/handbook/keys-addresses',
          },
          {
            to: '/docs/operate-a-stake-pool/generating-wallet-keys/',
            from: '/docs/stake-pool-course/handbook/create-stake-pool-keys',
          },
          {
            to: '/docs/operate-a-stake-pool/register-stake-address/',
            from: '/docs/stake-pool-course/handbook/register-stake-keys',
          },
          {
            to: '/docs/operate-a-stake-pool/register-stake-pool/',
            from: [ 
                    '/docs/stake-pool-course/handbook/generate-stake-pool-keys',
                    '/docs/stake-pool-course/handbook/register-stake-pool-metadata',
                  ]
          },
          {
            to: '/docs/operate-a-stake-pool/cardano-relay-configuration/',
            from: '/docs/stake-pool-course/handbook/configure-topology-files',
          },
        ],
      },
    ],
    [
      require.resolve('./src/plugins/changelog/index.js'),
      {
        blogTitle: 'Developer Portal Changelog',
        blogDescription:
          'Keep yourself up-to-date about new features in every release',
        blogSidebarCount: 'ALL',
        blogSidebarTitle: 'Changelog',
        routeBasePath: '/changelog',
        showReadingTime: false,
        postsPerPage: 20,
        archiveBasePath: null,
        authorsMapPath: 'authors.json',
        feedOptions: {
          type: 'all',
          title: 'Developer Portal Changelog',
          description:
            'Keep yourself up-to-date about new features in every release',
          language: 'en',
        },
      },
    ],
  ],
  
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        docs: {
          showLastUpdateAuthor: true,
          showLastUpdateTime: true,
          sidebarPath: require.resolve("./sidebars.js"),
          editUrl: `${vars.repository}/edit/${vars.branch}`,
        },
        blog: {
          showReadingTime: true,
          editUrl: `${vars.repository}/edit/${vars.branch}`,
          blogSidebarCount: 'ALL',
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        gtag: {
          // You can also use your "G-" Measurement ID here.
          trackingID: 'GTM-5NM3NX4',
          // Optional fields.
          anonymizeIP: true, // Should IPs be anonymized?
        },
      },
    ],
  ],
};