docusaurus.config.js

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

const {themes} = require('prism-react-renderer');
const lightCodeTheme = themes.github;

/** @type {import('@docusaurus/types').Config} */
const config = {
  // Change to Site title
  title: "Green Software Patterns",
  // Change to site description
  tagline:
    "An online open-source database of green software patterns reviewed and curated by the Green Software Foundation",
  // Change to site url
  url: "https://patterns.greensoftware.foundation/",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon.ico",
  organizationName: "Green-Software-Foundation",
  // Change to GitHub repo name.
  projectName: "green-software-patterns",
  deploymentBranch: "gh-pages",
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          routeBasePath: "/",
          // Change this to your repo.
          editUrl:
            "https://github.com/Green-Software-Foundation/patterns/edit/main/",
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        gtag: {
          trackingID: "G-G3P4S2WSTC",
        },
        sitemap: {
          changefreq: "weekly",
          priority: 0.5,
          ignorePatterns: ["/tags/**"],
          filename: "sitemap.xml",
        },
      }),
    ],
  ],  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      docs: {
        sidebar: {
          hideable: true,
          autoCollapseCategories: true,
        },
      },
      navbar: {
        // Change to project name
        title: "Green Software Patterns",
        logo: {
          alt: "Green Software Patterns Logo",
          src: "img/logo.svg",
        },
        items: [
          {
            type: "doc",
            docId: "catalog/requirements/index",
            position: "left",
            label: "Requirements",
          },
          {
            type: "doc",
            docId: "catalog/architecture/index",
            position: "left",
            label: "Architecture",
          },
          {
            type: "doc",
            docId: "catalog/development/index",
            position: "left",
            label: "Development",
          },
          {
            type: "doc",
            docId: "catalog/operations/index",
            position: "left",
            label: "Operations",
          },
          {
            type: "doc",
            docId: "catalog/testing/index",
            position: "left",
            label: "Testing",
          },
          {
            type: "doc",
            docId: "catalog/decommission/index",
            position: "left",
            label: "Decommission",
          },
          {
            type: "doc",
            docId: "catalog/end-user/index",
            position: "left",
            label: "End User",
          },
          {
            href: "https://greensoftware.foundation/",
            position: "right",
            label: "Green Software Foundation",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Links",
            items: [
              {
                label: "Github",
                href: "https://github.com/Green-Software-Foundation/green-software-patterns/",
              },
              {
                label: "Website",
                href: "https://patterns.greensoftware.foundation",
              },
            ],
          },
          {
            title: "LEGAL",
            items: [
              {
                label: "Trademark Policy",
                href: "https://greensoftware.foundation/policy/trademark",
              },
              {
                label: "Terms and Privacy Policy",
                href: "https://greensoftware.foundation/policy/terms",
              },
            ],
          },
          {
            title: "GSF Info",
            items: [
              {
                label: "Green Software Foundation",
                href: "https://greensoftware.foundation",
              },
              {
                label: "Twitter",
                href: "https://twitter.com/gsfcommunity",
              },
              {
                label: "Linkedin",
                href: "https://www.linkedin.com/company/green-software-foundation/",
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Joint Development Foundation Projects, LLC, Green Software Foundation Series`,
      },
      prism: {
        theme: lightCodeTheme,
      },
      colorMode: {
        disableSwitch: true,
        defaultMode: "light",
      },
      metadata: [{
        name: "twitter:card",
        content: "summary",
      },
      {
        name: "twitter:site",
        content: "@gsfcommunity",
      },
      {
        name: "twitter:title",
        content: "Green Software Patterns",
      },
      {
        name: "twitter:description",
        content: "An online open-source database of green software patterns reviewed and curated by the Green Software Foundation",
      },
      {
        name: "twitter:image",
        content: "https://patterns.greensoftware.foundation/img/og-image.png",
      },
      {
        name: "twitter:creator",
        content: "@gsfcommunity",
      },
      {
        name: "og:title",
        content: "Green Software Patterns",
      },
      {
        name: "og:description",
        content: "An online open-source database of green software patterns reviewed and curated by the Green Software Foundation",
      },
      {
        name: "og:image",
        content: "https://patterns.greensoftware.foundation/img/og-image.png",
      },
      {
        name: "og:url",
        content: "https://patterns.greensoftware.foundation/",
      },
      {
        name: "og:site_name",
        content: "Green Software Patterns",
      },
      {
        name: "og:type",
        content: "website",
      },

      ]
    }),  plugins: [
    [
      "@docusaurus/plugin-ideal-image",
      {
        quality: 90,
        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)
        disableInDev: false,
      },
    ],
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      {
        hashed: true,
        language: ["en"],
        indexDocs: true,
        indexBlog: false,
        docsRouteBasePath: "/",
        highlightSearchTermsOnTargetPage: true,
        searchResultLimits: 8,
        searchResultContextMaxLength: 50,
      },
    ],
  ],
};

module.exports = config;