ToolJet/docs/docusaurus.config.js

const devServerPlugin = require('./src/plugins/devServer/index.js');
import versionsArchived from './versionsArchived.json';

const baseArchivedURL = "https://archived-docs.tooljet.com/docs/";

const lastFiveArchivedVersions = versionsArchived
  .slice(0, 5)
  .map((version, index) => ({
    version,
    url: index === 0 ? baseArchivedURL : `${baseArchivedURL}${version}`
  }));

const isProd = process.env.NODE_ENV === 'production';

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
  title: 'ToolJet',
  tagline: 'Low-code framework to Build internal tools and business apps.',
  url: 'https://docs.tooljet.com',
  baseUrl: '/',
  onBrokenLinks: 'ignore',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/tooljet-ai-favicon.svg',
  organizationName: 'ToolJet', // Usually your GitHub org/user name.
  projectName: 'ToolJet', // Usually your repo name.
  themeConfig: {
    image: 'img/tooljet-ai-og-image.png',
    announcementBar: {
      id: 'support_us',
      content:
        'Star our repository on <a target="_blank" rel="noopener noreferrer" href="https://github.com/ToolJet/ToolJet">GitHub</a> to stay updated with new features and contribute to our platform!',
      backgroundColor: '#ECF0FE',
      textColor: '#4368E3',
      isCloseable: true,
    },
    docs: {
      sidebar: {
        hideable: true,
        autoCollapseCategories: true
      }
    },
    colorMode: {

    },
    navbar: {
      logo: {
        href: '/docs/',
        alt: 'ToolJet Logo',
        src: 'img/docs_logo.svg',
        srcDark: `img/docs_logo_dark.svg`,
        width: 120
      },
      items: [
        {
          type: 'docsVersionDropdown',
          position: 'left',
        },
        {
          type: 'search',
          position: 'right',
        },
        {
          href: 'https://www.tooljet.com/',
          position: 'right',
          label: 'Website',
          className: 'navbar-signin',
          'aria-label': 'Visit ToolJet Website',
        },
        {
          href: 'https://www.tooljet.com/login',
          position: 'right',
          label: 'Sign in',
          className: 'navbar-signin',
          'aria-label': 'Signin to ToolJet',
        },
        {
          href: 'https://www.tooljet.com/create-account',
          position: 'right',
          label: 'Try for free',
          className: 'navbar-website',
          'aria-label': 'Try ToolJet for free',
        },
      ],
    },
    footer: {
      style: 'light',
      logo: {
        alt: 'ToolJet Logo',
        src: '/img/docs_logo.svg',
        srcDark: '/img/docs_logo_dark.svg',
      },
      links: [
        {
          title: 'Platform',
          items: [
            { label: 'App builder', to: 'https://www.tooljet.com/visual-app-builder' },
            { label: 'AI Agent builder', to: 'https://www.tooljet.com/ai-agent-builder' },
            { label: 'ToolJet Database', to: 'https://www.tooljet.com/database' },
            { label: 'Trust Center', to: 'https://trust.tooljet.com/' },
          ],
        },
        {
          title: 'Solutions',
          items: [
            { label: 'Back office tools', to: 'https://www.tooljet.com/building-back-office-apps' },
            { label: 'Business applications', to: 'https://www.tooljet.com/business-applications' },
          ],
        },
        {
          title: 'Developers',
          items: [
            { label: 'Blogs', to: 'https://blog.tooljet.com/' },
            { label: 'Events', to: 'https://www.tooljet.com/events' },
            { label: 'GitHub', href: 'https://github.com/ToolJet/ToolJet' },
            { label: 'Slack', href: 'https://tooljet.com/slack' },
          ],
        },
        {
          title: 'Templates',
          items: [
            { label: 'Lead management', to: 'https://www.tooljet.com/templates/lead-management-system' },
            { label: 'KPI management', to: 'https://www.tooljet.com/templates/kpi-management-dashboard' },
            { label: 'Inventory management', to: 'https://www.tooljet.com/templates/inventory-management-system' },
            { label: 'Leave management', to: 'https://www.tooljet.com/templates/leave-management-portal' },
            { label: 'Applicant tracking', to: 'https://www.tooljet.com/templates/applicant-tracking-system' },
          ],
        },
        {
          title: 'Contact us',
          items: [
            { label: '[email protected]', href: 'mailto:[email protected]' },
            { label: '[email protected]', href: 'mailto:[email protected]' },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} ToolJet Solutions, Inc. All rights reserved.
      <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=4f00afac-ae1f-4cf6-8c53-8a2c7b3ca206" />
      <script>window.faitracker=window.faitracker||function(){this.q=[];var t=new CustomEvent("FAITRACKER_QUEUED_EVENT");return this.init=function(t,e,a){this.TOKEN=t,this.INIT_PARAMS=e,this.INIT_CALLBACK=a,window.dispatchEvent(new CustomEvent("FAITRACKER_INIT_EVENT"))},this.call=function(){var e={k:"",a:[]};if(arguments&&arguments.length>=1){for(var a=1;a<arguments.length;a++)e.a.push(arguments[a]);e.k=arguments[0]}this.q.push(e),window.dispatchEvent(t)},this.message=function(){window.addEventListener("message",function(t){"faitracker"===t.data.origin&&this.call("message",t.data.type,t.data.message)})},this.message(),this.init("c4rgfujgx6jef4722rcjfhj7dlmcipih",{host:"https://api.factors.ai"}),this}(),function(){var t=document.createElement("script");t.type="text/javascript",t.src="https://app.factors.ai/assets/factors.js",t.async=!0,(d=document.getElementsByTagName("script")[0]).parentNode.insertBefore(t,d)}();</script>
      <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-5L8R522S');</script>
      <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5L8R522S" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
      <script>
      (function () {
          const hubspotKeys = ['__hstc', '__hssc', '__hsfp'];
          const marketingKeys = ['utm_', '_hs', '_gl', 'li'];
          const exactKeys = ['gclid', '_ga', '_gid', 'msclkid', 'fbclid', 'li_fat_id', 'gbraid'];
          function getStoredParams() {
              const keys = JSON.parse(localStorage.getItem("storedQueryParamsKeys") || "[]");
              const params = {};
              keys.forEach(key => {
                  const val = localStorage.getItem(key);
                  if (val) params[key] = val;
              });
              return params;
          }
          function storeUTMParams() {
              try {
                  const url = new URL(window.location.href);
                  const params = new URLSearchParams(url.search);
                  const storedParams = {};
                  const keysToStore = [];
                  for (const [key, value] of params.entries()) {
                      const isMatch = exactKeys.includes(key) || marketingKeys.some(prefix => key.startsWith(prefix)) || hubspotKeys.includes(key);
                      if (isMatch && value && value !== '[object Object]') {
                        localStorage.setItem(key, value);
                          storedParams[key] = value;
                          keysToStore.push(key);
                      }
                  }
                  if (keysToStore.length > 0) {
                      localStorage.setItem("storedQueryParamsKeys", JSON.stringify(keysToStore));
                  }
              } catch (e) {
                  console.warn('UTM store error:', e);
              }
          }
          function appendTrackingToLinks() {
              const utmParams = getStoredParams();
              const links = document.querySelectorAll('a[href]');
              const allowedDomains = ['tooljet.ai', 'tooljet.com', 'tooljet.webflow.io', 'docs.tooljet.ai'];
              links.forEach(link => {
                  const href = link.getAttribute('href');
                  if (!href || href.startsWith('#') || href.startsWith('mailto:') || href.startsWith('tel:')) return;
                  const tempA = document.createElement('a');
                  tempA.href = href;
                  const isInternal = allowedDomains.some(domain => tempA.hostname.includes(domain));
                  if (!isInternal) return;
                  const linkParams = new URLSearchParams(tempA.search);
                  Object.entries(utmParams).forEach(([key, value]) => {
                      if (!linkParams.has(key)) linkParams.set(key, value);
                  });
                  const newHref = tempA.origin + tempA.pathname + (linkParams.toString() ? '?' + linkParams.toString() : '') + tempA.hash;
                  link.setAttribute('href', newHref);
              });
          }
          // NEW: Function to build URL with stored UTM parameters
          function buildUrlWithStoredParams(baseUrl) {
              try {
                  const storedParams = getStoredParams();
                  if (Object.keys(storedParams).length === 0) {
                      return baseUrl;
                  }
                  const url = new URL(baseUrl, window.location.origin);
                  const urlParams = new URLSearchParams(url.search);
                  // Add stored parameters that don't already exist in the URL
                  Object.entries(storedParams).forEach(([key, value]) => {
                      if (!urlParams.has(key)) {
                          urlParams.set(key, value);
                      }
                  });
                  const finalUrl = url.origin + url.pathname +
                      (urlParams.toString() ? '?' + urlParams.toString() : '') +
                      url.hash;
                  return finalUrl;
              } catch (e) {
                  console.warn('Error building URL with params:', e);
                  return baseUrl;
              }
          }
          function clearStoredUTMParams() {
              try {
                  const storedKeys = JSON.parse(localStorage.getItem("storedQueryParamsKeys") || "[]");
                  storedKeys.forEach(key => {
                      localStorage.removeItem(key);
                  });
                  localStorage.removeItem("storedQueryParamsKeys");
              } catch (e) {
                  console.warn('Error clearing UTM params:', e);
              }
          }
          // Run when the page loads
          window.addEventListener('load', () => {
              clearStoredUTMParams();
              storeUTMParams();
              appendTrackingToLinks();
          });
          // Run before the user leaves the page
          window.addEventListener('beforeunload', () => {
              clearStoredUTMParams();
          });
          // Expose functions for manual use
          window.clearStoredUTMParams = clearStoredUTMParams;
          window.getStoredUTMParams = getStoredParams; // NEW: Access stored params
          window.buildUrlWithStoredParams = buildUrlWithStoredParams; // NEW: Build URLs with UTM params
      })();
      </script>
      <script>
      document.addEventListener('DOMContentLoaded', function () {
          console.log("Script for cookie called");
          var cookieName = "source_page";
          var domain = ".tooljet.ai";
          var maxAge = 7 * 24 * 60 * 60; // 7 days
          var currentHost = window.location.hostname;
          var fullUrl = window.location.href;
          // Helper: read cookie
          function getCookie(name) {
              var match = document.cookie.match(new RegExp('(^| )' + name + '=([^;]+)'));
              return match ? decodeURIComponent(match[2]) : null;
          }
          // Helper: set cookie
          function setCookie(name, value, maxAgeSeconds, domain) {
              document.cookie =
                  name + "=" + encodeURIComponent(value) +
                  "; path=/; domain=" + domain +
                  "; max-age=" + maxAgeSeconds + ";";
          }
          // If user is on blog.tooljet.ai → always update cookie with latest blog URL
          // Else → do not overwrite, just keep existing one
          if (currentHost.includes("blog.tooljet.ai")) {
              setCookie(cookieName, fullUrl, maxAge, domain);
              console.log("Updated source_page cookie with latest blog URL: " + fullUrl);
          } else {
              console.log("Not on blog domain — keeping existing source_page: " + getCookie(cookieName));
          }
      });
      </script>
      <!-- Start of HubSpot Embed Code -->
      <script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/39494431.js"></script>
      <!-- End of HubSpot Embed Code -->
      `,
    },
    algolia: {
      appId: 'O8HQRLI0WA',
      apiKey: process.env.ALGOLIA_API_KEY || 'development', // Public API key: it is safe to commit it
      indexName: 'tooljet',
      contextualSearch: true,
      insights: true,
      externalUrlRegex: 'external\\.com|domain\\.com',
    },
  },
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          editUrl: 'https://github.com/ToolJet/Tooljet/blob/develop/docs/',
          includeCurrentVersion: false, // Set to true if you want to include the beta version in the sidebar
          lastVersion: '3.16.0-LTS',
          versions: {
            // Uncomment the following line to include the beta version in the sidebar
            // current: {
            //   label: 'beta 🚧',
            //   path: 'beta',
            //   banner: 'none',
            //   badge: false,
            // },
            "2.50.0-LTS": {
              label: '2.50.0-LTS (Legacy)',
              banner: 'none',
              badge: false
            },
            "3.0.0-LTS": {
              banner: 'none',
              badge: false
            },
            "3.5.0-LTS": {
              banner: 'none',
              badge: false
            },
            "3.16.0-LTS": {
              label: '3.16 - 3.20 LTS',
              banner: 'none',
              badge: false
            }
          }
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        sitemap: {
          changefreq: 'weekly',
          priority: 0.5,
          ignorePatterns: ['/docs/1.x.x/**'],
          filename: 'sitemap.xml',
        },

        googleTagManager: isProd
          ? {
            containerId: process.env.GTM || 'development',
          }
          : undefined,
      },
    ],
    [
    'redocusaurus',
    {
      openapi: {
        path: 'openapi',       // scans all folders inside openapi/, e.g., scim, tj-api
        routeBasePath: '/api', // pages will be /api/scim, /api/tj-api
      },
      theme: {
        primaryColor: '#1890ff', // customize the color
      },
    },
  ],
  ],
  plugins: [
    devServerPlugin,
    'plugin-image-zoom',
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            to: '/docs/',
            from: '/',
          },
          {
            to: 'https://join.slack.com/t/tooljet/shared_invite/zt-38298nyhf-hK7tNkKNPwYSg1BhRU5mTA',
            from: '/docs/slack',
          },
          {
            to: '/docs/security/constants/',
            from: '/docs/org-management/workspaces/workspace_constants/',
          },
          {
            to: '/docs/development-lifecycle/gitsync/overview',
            from: '/docs/gitsync',
          },
          {
            to: '/docs/user-management/role-based-access/access-control',
            from: '/docs/tutorial/manage-users-groups',
          },
          {
            to: '/docs/security/constants/variables',
            from: '/docs/org-management/workspaces/workspace-variables-migration',
          },
          {
            to: '/docs/tj-setup/smtp-setup/configuration',
            from: '/docs/org-management/smtp-configuration/',
          },
          {
            to: '/docs/user-management/authentication/self-hosted/instance-login',
            from: '/docs/enterprise/superadmin',
          },
          {
            to: '/docs/user-management/sso/oidc/setup',
            from: '/docs/category/openid-connect',
          },
          {
            to: '/docs/development-lifecycle/release/share-app',
            from: '/docs/dashboard',
          },
          {
            to: '/docs/security/audit-logs',
            from: '/docs/enterprise/audit_logs/',
          },
          {
            to: '/docs/tj-setup/org-branding/white-labeling',
            from: '/docs/enterprise/white-label',
          },
          {
            to: '/docs/tj-setup/licensing/self-hosted',
            from: '/docs/org-management/licensing/self-hosted',
          },
          {
            to: '/docs/user-management/role-based-access/access-control',
            from: '/docs/org-management/permissions/',
          },
          {
            to: '/docs/tj-setup/workspaces',
            from: '/docs/org-management/workspaces/workspace_overview',
          },
          {
            to: '/docs/security/constants/variables',
            from: '/docs/org-management/workspaces/workspace-variables',
          },
          {
            to: '/docs/development-lifecycle/gitsync/delete-gitsync',
            from: '/docs/release-management/gitsync/delete-gitsync',
          },
          // Commenting out the following redirects to resolve the build error during the 3.16.0-LTS release [Time Constraint]
          // {
          //   to: '/docs/development-lifecycle/gitsync/connect-to-git-repo/ssh/ssh-config',
          //   from: '/docs/release-management/gitsync/ssh-config',
          // },
          // {
          //   to: '/docs/development-lifecycle/gitsync/connect-to-git-repo/ssh/gitsync-config',
          //   from: '/docs/release-management/gitsync/tj-config',
          // },
          {
            to: '/docs/development-lifecycle/environment/self-hosted/multi-environment',
            from: '/docs/release-management/multi-environment',
          },
          {
            to: '/docs/security/compliance',
            from: '/docs/security/',
          },
          {
            to: '/docs/setup/try-tooljet/',
            from: '/docs/setup/client/',
          },
          {
            to: '/docs/build-with-ai/overview',
            from: '/docs/tooljet-ai/overview',
          },
          {
            to: '/docs/tooljet-api',
            from: '/docs/tutorial/tooljet-api',
          },
          {
            to: '/docs/user-management/authentication/self-hosted/overview',
            from: '/docs/user-authentication/general-settings',
          },
          {
            to: '/docs/user-management/authentication/self-hosted/instance-login',
            from: '/docs/user-authentication/password-login',
          },
          {
            to: '/docs/user-management/sso/github',
            from: '/docs/user-authentication/sso/github',
          },
          {
            to: '/docs/user-management/sso/google',
            from: '/docs/user-authentication/sso/google',
          },
          {
            to: '/docs/user-management/sso/oidc/setup',
            from: '/docs/user-authentication/sso/oidc',
          },
          {
            to: '/docs/user-management/sso/oidc/azuread',
            from: '/docs/user-authentication/sso/openid/azuread/',
          },
          {
            to: '/docs/user-management/sso/oidc/google',
            from: '/docs/user-authentication/sso/openid/google-openid',
          },
          {
            to: '/docs/user-management/sso/oidc/okta',
            from: '/docs/user-authentication/sso/openid/okta',
          },
          {
            to: '/docs/user-management/sso/oidc/setup',
            from: '/docs/user-authentication/sso/openid/setup',
          },
          {
            to: '/docs/user-management/sso/saml/setup',
            from: '/docs/user-authentication/sso/saml',
          },
          {
            to: '/docs/user-management/onboard-users/overview',
            from: '/docs/user-authentication/user-lifecycle/',
          },
          {
            to: '/docs/user-management/authentication/self-hosted/workspace-login',
            from: '/docs/user-authentication/workspace-login',
          },
          {
            to: '/docs/widgets/table/',
            from: '/docs/widgets/table/table-properties',
          },
          {
            to: '/docs/setup/upgrade-to-v3',
            from: '/docs/setup/cloud-v3-migration',
          },
          // {
          //   to: '/docs/workflows/how-to/trigger-workflow-from-app',
          //   from: '/docs/workflows/trigger-workflow-from-app',
          // }
        ],
      },
    ],
  ],
};