docusaurus.config.js

// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";
import commonRoomScript from "./src/scripts/commonroom.js";
import hubspotScript from "./src/scripts/hubspot.js";
import scarfScript from "./src/scripts/scarf.js";

const remarkReplace = require("./src/remark/remark-replace");
// Math equation plugins
const math = require("remark-math");
const katex = require("rehype-katex");
const siteRedirects = require("./site.redirects");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Weaviate Documentation",
  tagline:
    "Weaviate empowers developers to deliver, scalable vector search-powered apps painlessly",
  favicon: "img/favicon.ico",
  staticDirectories: ["static"],
  // url: "https://weaviate.io",
  url: "https://docs.weaviate.io",
  baseUrl: "/",
  trailingSlash: false,
  onBrokenLinks: "warn",
  clientModules: [require.resolve("./src/components/UTM/capture.js")],
  markdown: {
    hooks: {
      onBrokenMarkdownLinks: "warn",
      onBrokenMarkdownImages: "throw",
    },
    mermaid: true,
    // Interpolate ||site.*|| tokens on raw file content, for every md/mdx file.
    // The remark-replace plugin below only runs on docs pages; partials imported
    // from _includes/ are compiled by Docusaurus' MDX *fallback* loader, which
    // does not receive the docs preset's remarkPlugins, so ||site.*|| tokens in
    // those partials (e.g. code snippets in the quickstart install tabs) were
    // never interpolated. This preprocessor covers every file, including
    // fallback-loaded partials. It shares one implementation with the plugin and
    // is idempotent, so it does not affect pages the plugin already handles.
    preprocessor: ({ fileContent, filePath }) =>
      remarkReplace.replaceSiteTokens(fileContent, filePath),
  },

  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  headTags: [commonRoomScript, hubspotScript, scarfScript],

  plugins: [
    "docusaurus-plugin-sass",
    ["@docusaurus/plugin-client-redirects", siteRedirects],
    [
      "@scalar/docusaurus",
      {
        label: "",
        route: "/weaviate/api/rest",
        cdn: "https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.49.0",
        configuration: {
          spec: {
            url: "https://raw.githubusercontent.com/weaviate/weaviate/v1-38/openapi-for-docs/openapi-specs/schema.json",
          },
          hideModels: true,
          showSidebar: true,
        },
      },
    ],
    [
      "@scalar/docusaurus",
      {
        id: "engram-api",
        label: "",
        route: "/engram/api/rest",
        cdn: "https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.49.0",
        configuration: {
          spec: {
            url: "/specs/engram-openapi.json",
          },
          hideModels: true,
          showSidebar: true,
        },
      },
    ],
    // [
    //   "@signalwire/docusaurus-plugin-llms-txt",
    //   {
    //     siteTitle: "Weaviate Documentation",
    //     siteDescription:
    //       "Comprehensive guides and references for Weaviate, the open-source vector database. " +
    //       "Sections labeled [CODE] contain runnable multi-language code examples (Python, TypeScript, Go, Java, C#). " +
    //       "Sections labeled [REFERENCE] contain configuration details and API specs. " +
    //       "Sections labeled [CONCEPTS] contain theoretical explanations.",
    //     depth: 3,
    //     includeOrder: [
    //       "/weaviate/connections/**",
    //       "/weaviate/manage-collections/**",
    //       "/weaviate/manage-objects/**",
    //       "/weaviate/search/**",
    //       "/weaviate/configuration/**",
    //       "/weaviate/client-libraries/**",
    //       "/weaviate/starter-guides/**",
    //       "/weaviate/tutorials/**",
    //       "/weaviate/quickstart/**",
    //       "/weaviate/concepts/**",
    //       "/weaviate/config-refs/**",
    //       "/weaviate/api/**",
    //       "/weaviate/model-providers/**",
    //     ],
    //     optionalLinks: [
    //       {
    //         title: "Weaviate Python Client API Reference",
    //         url: "https://weaviate.github.io/weaviate-python-client/",
    //         description: "Full Python client API reference (external).",
    //       },
    //       {
    //         title: "Weaviate TypeScript Client API Reference",
    //         url: "https://weaviate.github.io/typescript-client/",
    //         description: "Full TypeScript client API reference (external).",
    //       },
    //     ],
    //     content: {
    //       //excludeRoutes: ["/contributor-guide/**"], // Throwing an error in GitHub Actions
    //       enableMarkdownFiles: false,
    //       routeRules: [
    //         // Code-heavy how-to sections
    //         { route: "/weaviate/connections/**", categoryName: "[CODE] Connect to Weaviate" },
    //         { route: "/weaviate/manage-collections/**", categoryName: "[CODE] Manage Collections" },
    //         { route: "/weaviate/manage-objects/**", categoryName: "[CODE] Manage Objects (CRUD)" },
    //         { route: "/weaviate/search/**", categoryName: "[CODE] Search and Queries" },
    //         { route: "/weaviate/configuration/**", categoryName: "[CODE] Configuration How-Tos" },
    //         { route: "/weaviate/client-libraries/**", categoryName: "[CODE] Client Libraries and SDKs" },
    //         { route: "/weaviate/starter-guides/**", categoryName: "[CODE] Starter Guides" },
    //         { route: "/weaviate/tutorials/**", categoryName: "[CODE] Tutorials" },
    //         { route: "/weaviate/quickstart/**", categoryName: "[CODE] Quickstart" },
    //         // Reference sections
    //         { route: "/weaviate/config-refs/**", categoryName: "[REFERENCE] Configuration Reference" },
    //         { route: "/weaviate/api/**", categoryName: "[REFERENCE] API Reference (REST, GraphQL, gRPC)" },
    //         // Concepts sections
    //         { route: "/weaviate/concepts/**", categoryName: "[CONCEPTS] Architecture and Theory" },
    //         { route: "/weaviate/benchmarks/**", categoryName: "[CONCEPTS] Benchmarks" },
    //         { route: "/weaviate/best-practices/**", categoryName: "[CONCEPTS] Best Practices" },
    //         { route: "/weaviate/more-resources/**", categoryName: "[CONCEPTS] More Resources" },
    //         // Other
    //         { route: "/weaviate/model-providers/**", categoryName: "Model Provider Integrations" },
    //       ],
    //     },
    //     //logLevel: 3, // Uncomment to enable debug logging
    //   },
    // ],
    [
      "@docusaurus/plugin-google-tag-manager",
      {
        containerId: process.env.GOOGLE_CONTAINER_ID || "None",
      },
    ],
  ],
  themes: ["@docusaurus/theme-mermaid"],
  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          path: "docs",
          routeBasePath: "/",
          editUrl: "https://github.com/weaviate/docs/tree/main/",
          remarkPlugins: [remarkReplace, math],
          rehypePlugins: [katex],
        },
        pages: {
          path: "src/pages",
        },
        theme: {
          customCss: [
            require.resolve("./src/css/custom.scss"),
            require.resolve("./src/css/blog-and-docs.scss"),
          ],
        },
      }),
    ],
  ],
  stylesheets: [
    // Add Font Awesome stylesheets
    "/fonts/font-awesome/fontawesome.css",
    "/fonts/font-awesome/solid.css",
    "/fonts/font-awesome/regular.css",
    "/fonts/font-awesome/brands.css",
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      image: "og/default.jpg",
      announcementBar: {
        id: "announcement-bar-engram-2026",
        content: `<a href="/engram/">Introducing <b>Engram</b> — managed memory for AI agents, built on Weaviate</a>`,
        backgroundColor: "#1C1468",
        textColor: "#F5F5F5",
        isCloseable: true,
      },
      navbar: {
        title: "",
        logo: {
          alt: "Weaviate",
          src: "/img/site/weaviate-logo-horizontal-light-1.svg",
          srcDark: "/img/site/weaviate-logo-horizontal-dark-1.svg",
          href: "https://weaviate.io",
        },
        items: [
          {
            html: `<svg class="githubStars" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>`,
            to: "https://github.com/weaviate/weaviate",
            position: "right",
          },
          {
            label: "Support",
            className: "support-button",
            to: "/support",
            position: "right",
          },
          {
            label: "Weaviate Cloud",
            className: "cloud-button",
            to: "/go/console?utm_content=navbar",
            position: "right",
          },
          {
            type: "search",
            position: "right",
            className: "hiddenSearch",
          },
        ],
      },
      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
        additionalLanguages: ["java", "csharp", "bash"],
      },
      docs: {
        sidebar: {
          hideable: true,
        },
      },
    }),
};

export default config;