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");

// process.env.VERCEL_URL

let siteURL = "https://platform.noteable.io";

if (process.env.VERCEL_URL) {
  siteURL = `https://${process.env.VERCEL_URL}`;
}

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Noteable Platform",
  tagline: "Data Driven Documents for Developers",
  favicon: "img/favicon.ico",

  // Set the production url of your site here
  url: siteURL,
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: "/",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "noteable-io", // Usually your GitHub org/user name.
  projectName: "platform-site", // Usually your repo name.

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",

  // Even if you don't use internalization, you can use this field to set useful
  // metadata like html lang. For example, if your site is Chinese, you may want
  // to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          // editUrl: "https://github.com/..."
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        googleTagManager: {
          containerId: "GTM-P7TZQLM",
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      algolia: {
        // The application ID provided by Algolia
        appId: "00JXOQ2DJ1",

        // Public API key: it is safe to commit it
        apiKey: "9bab4e48c02dee9bff1b5a4758937dc3",

        indexName: "platformable",

        // Optional: see doc section below
        contextualSearch: true,

        // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
        // externalUrlRegex: 'external\\.com|domain\\.com',

        // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
        // replaceSearchResultPathname: {
        //   from: '/docs/', // or as RegExp: /\/docs\//
        //   to: '/',
        // },

        // Optional: Algolia search parameters
        // searchParameters: {},

        // Optional: path for search page that enabled by default (`false` to disable it)
        searchPagePath: "search",
      },
      colorMode: {
        respectPrefersColorScheme: true,
      },
      image: "img/noteable-platform-social-card.png",
      metadata: [{ name: "twitter:site", content: "@noteable_io" }],
      navbar: {
        title: "Noteable Developer Platform",
        logo: {
          alt: "Noteable",
          src: "img/logo.svg",
        },
        items: [
          {
            type: "docSidebar",
            sidebarId: "docSidebar",
            position: "left",
            label: "Docs",
          },
          { to: "/blog", label: "Blog", position: "left" },
          {
            href: "https://github.com/noteable-io",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Docs",
            items: [
              {
                label: "Introduction",
                to: "/docs/intro",
              },
            ],
          },
          {
            title: "Community",
            items: [
              {
                label: "Noteable Community",
                href: "https://community.noteable.io",
              },
              {
                label: "Twitter",
                href: "https://twitter.com/noteable_io",
              },
            ],
          },
          {
            title: "Platform",
            items: [
              {
                label: "Noteable App",
                href: "https://app.noteable.io",
              },
              {
                label: "Developer Blog",
                to: "/blog",
              },
              {
                label: "GitHub",
                href: "https://github.com/noteable-io",
              },
            ],
          },
          {
            title: "Noteable",
            items: [
              {
                label: "Home",
                href: "https://noteable.io",
              },
              {
                label: "Product Blog",
                to: "https://noteable.io/blog",
              },
              {
                label: "Pricing",
                href: "https://noteable.io/pricing",
              },
            ],
          },
        ],
        copyright: `Copyright &copy; ${new Date().getFullYear()} Noteable, Inc. Built with Docusaurus.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
      zoom: {
        selector: ".markdown :not(em) > img",
        background: {
          light: "rgb(255, 255, 255, 0.9)",
          dark: "rgb(30, 30, 30, 0.9)",
        },
        config: {
          // options you can specify via https://github.com/francoischalifour/medium-zoom#usage
        },
      },
    }),

  plugins: [require.resolve("docusaurus-plugin-image-zoom")],
};

module.exports = config;