docusaurus.config.js

const path = require("path");
const math = require("remark-math");
const katex = require("rehype-katex");
const { versions, versionedPages, versionedCategories } = require("./dbt-athena-versions");
require("dotenv").config();

/* Debugging */
let SITE_URL;
if (!process.env.CONTEXT || process.env.CONTEXT == "production") {
  SITE_URL = "https://dbt-athena.github.io";
} else {
  SITE_URL = process.env.DEPLOY_URL;
}

let GIT_BRANCH;
if (!process.env.CONTEXT || process.env.CONTEXT == "production") {
  GIT_BRANCH = "main";
} else {
  GIT_BRANCH = process.env.HEAD;
}

let { ALGOLIA_APP_ID, ALGOLIA_API_KEY, ALGOLIA_INDEX_NAME } = process.env;

let metatags = [];
// If Not "main" Branch, do not index site
if (GIT_BRANCH !== "main") {
  metatags.push({
    tagName: "meta",
    attributes: {
      name: "robots",
      content: "noindex",
    },
  });
}

console.log("DEBUG: CONTEXT =", process.env.CONTEXT);
console.log("DEBUG: DEPLOY_URL =", process.env.DEPLOY_URL);
console.log("DEBUG: SITE_URL = ", SITE_URL);
console.log("DEBUG: ALGOLIA_INDEX_NAME = ", ALGOLIA_INDEX_NAME);
console.log("DEBUG: metatags = ", metatags);
console.log("DEBUG: PREVIEW_PATH = ", process.env.PREVIEW_PATH);

// Preview PR urls need a different base URL
const baseUrl = process.env.PREVIEW_PATH ? process.env.PREVIEW_PATH : "/";

var siteSettings = {
  baseUrl,
  tagline: "Documentation for dbt-athena",
  title: "dbt-athena docs",
  url: SITE_URL,
  favicon: "img/favicon.svg",

  // GitHub pages deployment config.
  organizationName: "dbt-athena",
  projectName: "docs.getdbt.com",

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "throw",
  trailingSlash: false,
  themeConfig: {
    docs: {
      sidebar: {
        hideable: true,
      },
    },
    image: "/img/avatar.png",
    colorMode: {
      defaultMode: "light",
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    // Adding non-empty strings for Algolia config
    // allows Docusaurus to run locally without .env file
    algolia: {
      apiKey: ALGOLIA_API_KEY ? ALGOLIA_API_KEY : "dbt",
      indexName: ALGOLIA_INDEX_NAME ? ALGOLIA_INDEX_NAME : "dbt",
      appId: ALGOLIA_APP_ID ? ALGOLIA_APP_ID : "dbt",
      //debug: true,
    },
    prism: {
      theme: (() => {
        var theme = require("prism-react-renderer/themes/nightOwl");
        // Add additional rule to nightowl theme in order to change
        // the color of YAML keys (to be different than values).
        // There weren't many Prism themes that differentiated
        // YAML keys and values. See link:
        // https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes
        theme.styles.push({
          types: ["atrule"],
          style: {
            // color chosen from the nightowl theme palette
            // https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/themes/nightOwl.js#L83
            color: "rgb(255, 203, 139)",
          },
        });
        return theme;
      })(),
      additionalLanguages: ["bash"],
    },
    navbar: {
      hideOnScroll: true,
      logo: {
        src: "/img/dbt-athena-logo.svg",
        srcDark: "img/dbt-athena-logo-dark.svg",
        alt: "dbt-athena Logo",
      },
      items: [
        {
          to: "/",
          label: "Docs",
          position: "left",
          activeBaseRegex: "docs/(?!(dbt-cloud))",
        },
      ],
    },
    footer: {
      links: [
        {
          html: `
          <div class='footer__items'>
          </div>

          <div class='footer__items--right'>
            <a href='https://www.getdbt.com/community/join-the-community/'><i class="fa-brands fa-slack"></i></a>
            <a href='https://github.com/dbt-athena/dbt-athena'><i class="fa-brands fa-github"></i></a>
          </div>
          `,
        },
      ],

      copyright: `&copy; ${new Date().getFullYear()} dbt-athena.`,
    },
  },
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        docs: {
          path: "docs",
          routeBasePath: "/",
          sidebarPath: require.resolve("./sidebars.js"),
          remarkPlugins: [math],
          rehypePlugins: [katex],

          editUrl: "https://github.com/dbt-athena/dbt-athena.github.io/edit/" + GIT_BRANCH,
          showLastUpdateTime: true,
          //showLastUpdateAuthor: false,

          sidebarCollapsible: true,
        },
        blog: false,
      },
    ],
  ],
  plugins: [
    [path.resolve("plugins/insertMetaTags"), { metatags }],
    path.resolve("plugins/svg"),
    path.resolve("plugins/customWebpackConfig"),
    [path.resolve("plugins/buildGlobalData"), { versionedPages, versionedCategories }],
  ],
  scripts: ["https://kit.fontawesome.com/7110474d41.js"],
  stylesheets: [
    `${baseUrl}css/fonts.css`,
    `${baseUrl}css/entypo.css`,
    `${baseUrl}css/search.css`,
    `${baseUrl}css/api.css`,
    "https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;500;600;700&display=swap",
    "https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;500;600;700&display=swap",
    {
      href: "https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css",
      type: "text/css",
      integrity: "sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
      crossorigin: "anonymous",
    },
  ],
};

// If versions json file found, add versions dropdown to nav
if (versions) {
  siteSettings.themeConfig.navbar.items.push({
    label: "Versions",
    position: "left",
    className: "nav-versioning",
    items: [
      ...versions.reduce((acc, version) => {
        if (version?.version) {
          acc.push({
            label: `${version.version}`,
            href: "#",
          });
        }
        return acc;
      }, []),
    ],
  });
}

module.exports = siteSettings;