docusaurus.config.js

//@ts-check
const path = require("path");
const visit = require("unist-util-visit");
const FontPreloadPlugin = require("webpack-font-preload-plugin");

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
  title: "Temporal Documentation",
  tagline: "Build invincible applications",
  url: "https://docs.temporal.io",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "throw",
  favicon: "img/favicon.png",
  organizationName: "temporalio", // Usually your GitHub org/user name.
  projectName: "temporal-documentation", // Usually your repo name.
  headTags: [
    {
      tagName: "link",
      attributes: {
        rel: "preload",
        href: "https://iq.temporal.io",
        as: "document",
      },
    },
  ],
  themeConfig: {
    colorMode: {
      defaultMode: "light",
      disableSwitch: false,
      // switchConfig: {
      //   darkIcon: "🌙",
      //   darkIconStyle: {
      //     content: `url(/img/moon.svg)`,
      //     transform: "scale(2)",
      //     margin: "0 0.2rem",
      //   },
      //   lightIcon: "\u{1F602}",
      //   lightIconStyle: {
      //     content: `url(/img/sun.svg)`,
      //     transform: "scale(2)",
      //   },
      // },
    },
    metadata: [{ name: "robots", content: "follow, index" }],
    prism: {
      theme: require("prism-react-renderer/themes/nightOwlLight"),
      darkTheme: require("prism-react-renderer/themes/dracula"),
      additionalLanguages: ["java", "ruby", "php"],
    },
    docs: {
      sidebar: {
        hideable: true,
        autoCollapseCategories: true,
      },
    },
    announcementBar: {
      id: "replay_announcement",
      content: 'Get your tickets for <a href="https://temporal.io/replay">Replay 2023</a>!',
      backgroundColor: "#141414",
      textColor: "#ffffff",
      isCloseable: true,
    },
    navbar: {
      hideOnScroll: false,
      logo: {
        alt: "Temporal logo",
        src: "img/temporal-logo-dark.svg",
        srcDark: "img/temporal-logo.svg",
        href: "https://temporal.io",
      },
      items: [
        {
          label: "Home",
          to: "/",
          position: "left",
          activeBasePath: "none",
        },
        {
          label: "Temporal Cloud",
          to: "/cloud",
          activeBasePath: "cloud",
          position: "left",
        },
        {
          label: "KB articles",
          to: "/kb",
          activeBasePath: "kb",
          position: "left",
        },
        {
          label: "Docs changelog",
          to: "/changelog",
          activeBasePath: "changelog",
          position: "left",
        },
        {
          label: "Learn Temporal",
          href: "https://learn.temporal.io",
          right: "left",
        },
      ],
    },
    footer: {
      logo: {
        alt: "Temporal logo",
        src: "img/favicon.png",
        href: "https://temporal.io",
        width: 24,
      },
      copyright: `Copyright © ${new Date().getFullYear()}</span> Temporal Technologies Inc.</div><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-TSXFPF2"
      height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>`,
      links: [
        {
          items: [
            {
              label: "Github",
              href: "https://github.com/temporalio/temporal",
            },
            {
              label: "Twitter",
              href: "https://twitter.com/temporalio",
            },
            {
              label: "YouTube",
              href: "https://www.youtube.com/c/Temporalio",
            },
            {
              label: "About the docs",
              href: "https://github.com/temporalio/documentation/blob/master/README.md",
            },
          ],
        },
        {
          items: [
            {
              label: "Temporal Cloud",
              href: "https://temporal.io/cloud",
            },
            {
              label: "Meetups",
              href: "https://lu.ma/temporal",
            },
            {
              label: "Workshops",
              href: "https://temporal.io/community#workshops",
            },
            {
              label: "Support forum",
              href: "https://community.temporal.io/",
            },
            {
              label: "Ask an expert",
              href: "https://pages.temporal.io/ask-an-expert",
            },
          ],
        },
        {
          items: [
            {
              label: "Learn Temporal",
              href: "https://learn.temporal.io",
            },
            {
              label: "Blog",
              href: "https://temporal.io/blog",
            },
            {
              label: "Use cases",
              href: "https://temporal.io/use-cases",
            },
            {
              label: "Newsletter signup",
              href: "https://pages.temporal.io/newsletter-subscribe",
            },
          ],
        },
        {
          items: [
            {
              label: "Security",
              to: "/security",
            },
            {
              label: "Privacy policy",
              to: "/privacy-policy",
            },
            {
              label: "Terms of service",
              href: "https://docs.temporal.io/pdf/temporal-tos-2021-07-24.pdf",
            },
            {
              label: "We're hiring",
              href: "https://temporal.io/careers",
            },
          ],
        },
      ],
    },
    algolia: {
      apiKey: "4a2fa646f476d7756a7cdc599b625bec",
      indexName: "temporal",
      externalUrlRegex: "temporal\\.io",
      // contextualSearch: true, // Optional; if you have different version of docs etc (v1 and v2), doesn't display dup results
      appId: "T5D6KNJCQS", // Optional, if you run the DocSearch crawler on your own
      // algoliaOptions: {}, // Optional, if provided by Algolia
    },
  },
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        // Will be passed to @docusaurus/plugin-content-docs
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          routeBasePath: "/",
          exclude: ["**/php/**", "**/typescript/**", "**/go/**", "**/java/**", "**/clusters/**"], // do not render context content
          // editUrl: "https://github.com/temporalio/documentation/blob/master",
          /**
           * Whether to display the author who last updated the doc.
           */
          showLastUpdateAuthor: false,
          /**
           * Whether to display the last date the doc was updated.
           */
          showLastUpdateTime: false,
          /**
           * Skip the next release docs when versioning is enabled.
           * This will not generate HTML files in the production build for documents
           * in `/docs/next` directory, only versioned docs.
           */
          // excludeNextVersionDocs: false,
          includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
          // // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
          // // original PR https://github.com/temporalio/documentation/pull/496/files
          remarkPlugins: [
            [
              () =>
                function addTSNoCheck(tree) {
                  // Disable TS type checking for any TypeScript code blocks.
                  // This is because imports are messy with snipsync: we don't
                  // have a way to pull in a separate config for every example
                  // snipsync pulls from.
                  function visitor(node) {
                    if (!/^ts$/.test(node.lang)) {
                      return;
                    }
                    node.value = "// @ts-nocheck\n" + node.value;
                  }

                  visit(tree, "code", visitor);
                },
              {},
            ],
            [
              require("remark-typescript-tools").transpileCodeblocks,
              {
                compilerSettings: {
                  tsconfig: path.join(__dirname, "tsconfig.json"),
                  externalResolutions: {},
                },
                fileExtensions: [".md", ".mdx"],
                // remark-typescript-tools automatically running prettier with a custom config that doesn't
                // line up with ours. This disables any post processing, including the default prettier step.
                postProcessTs: (files) => files,
                postProcessTranspiledJs: (files) => files,
              },
            ],
            [
              () =>
                function removeTSNoCheck(tree) {
                  function visitor(node) {
                    if (!/^ts$/.test(node.lang) && !/^js$/.test(node.lang)) {
                      return;
                    }
                    if (node.value.startsWith("// @ts-nocheck\n")) {
                      node.value = node.value.slice("// @ts-nocheck\n".length);
                      if (node.lang === "ts") {
                        node.value = dedent(node.value);
                      }
                    }
                    // If TS compiled output is empty, replace it with a more helpful comment
                    if (node.lang === "js" && node.value.trim() === "export {};") {
                      node.value = "// Not required in JavaScript";
                    } else if (node.lang === "js") {
                      node.value = convertIndent4ToIndent2(node.value).trim();
                    }
                  }
                  visit(tree, "code", visitor);
                },
              {},
            ],
          ],
        },
        // Will be passed to @docusaurus/plugin-content-blog
        // options: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog
        // blog: {},
        // Will be passed to @docusaurus/theme-classic.
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        // gtag: {
        //   trackingID: "GTM-TSXFPF2",
        //   // Optional fields.
        //   anonymizeIP: false, // Should IPs be anonymized?
        // },
        // Will be passed to @docusaurus/plugin-content-sitemap
        sitemap: {
          // Per v2.0.0-alpha.72 cacheTime is now deprecated
          //cacheTime: 600 * 1000, // 600 sec - cache purge period
          changefreq: "daily",
          priority: 0.5,
          filename: "sitemap.xml",
        },
      },
    ],
  ],
  scripts: [
    {
      src: "/scripts/googletag.js",
      async: true,
      defer: true,
    },
    {
      src: "/scripts/set-tab-language.js",
      async: true,
      defer: true,
    },
  ],
  plugins: [
    function preloadFontPlugin() {
      return {
        name: "preload-font-plugin",
        configureWebpack() {
          return {
            plugins: [new FontPreloadPlugin()],
          };
        },
      };
    },
    [
      "@docusaurus/plugin-content-blog",
      {
        /**
         * Required for any multi-instance plugin
         */
        id: "changelog",
        /**
         * URL route for the blog section of your site.
         * *DO NOT* include a trailing slash.
         */
        routeBasePath: "changelog",
        /**
         * Path to data on filesystem relative to site dir.
         */
        blogTitle: "Temporal documentation changelog",
        blogSidebarTitle: "Docs changelog",
        path: "changelog",
        routeBasePath: "changelog",
        blogSidebarCount: "ALL",
        blogDescription: "A log of changes to this site's content.",
        showReadingTime: false, // Show estimated reading time for the blog post.
        feedOptions: {
          type: "all",
          copyright: `Copyright © ${new Date().getFullYear()} Temporal Technologies Inc.  All rights reserved. Copyright © 2020 Uber Technologies, Inc.`,
        },
      },
    ],
    [
      "@docusaurus/plugin-content-blog",
      {
        /**
         * Required for any multi-instance plugin
         */
        id: "kb",
        /**
         * URL route for the blog section of your site.
         * *DO NOT* include a trailing slash.
         */
        routeBasePath: "kb",
        /**
         * Path to data on filesystem relative to site dir.
         */
        path: "kb",
        blogTitle: "Temporal Platform knowledge base",
        blogSidebarTitle: "KB articles",
        blogSidebarCount: "ALL",
        blogDescription: "User facing Temporal Platform knowledge base articles",
        showReadingTime: false, // Show estimated reading time for the blog post.
        feedOptions: {
          type: "all",
          copyright: `Copyright © ${new Date().getFullYear()} Temporal Technologies Inc.  All rights reserved. Copyright © 2020 Uber Technologies, Inc.`,
        },
      },
    ],
  ],
};

function convertIndent4ToIndent2(code) {
  // TypeScript always outputs 4 space indent. This is a workaround.
  // See https://github.com/microsoft/TypeScript/issues/4042
  return code.replace(/^( {4})+/gm, (match) => {
    return "  ".repeat(match.length / 4);
  });
}

// Remove the minimum leading whitespace on each line, excluding whitespace-only
// lines. Helpful for cleaning up TypeScript examples that are pulled from
// the body of a function.
function dedent(code) {
  const lines = code.split("\n");

  if (!lines.length) {
    return code;
  }

  // First, find the minimum number of leading space characters, excluding
  // lines that are whitespace-only.
  let minIndent = Number.POSITIVE_INFINITY;
  for (const line of lines) {
    if (line.trim().length === 0) {
      continue;
    }

    const match = line.match(/^( +)/);
    if (match && match[0].length < minIndent) {
      minIndent = match[0].length;
    } else if (!match) {
      minIndent = 0;
    }
  }

  // If there's no leading whitespace, just return the code
  if (minIndent === 0 || minIndent === Number.POSITIVE_INFINITY) {
    return code;
  }

  // Otherwise, remove leading spaces from each line
  return lines.map((line) => line.replace(new RegExp(`^ {${minIndent}}`), "")).join("\n");
}