docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const { themes } = require('prism-react-renderer')
const path = require('path');

const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Clarifai Docs',
  tagline: 'Clarifai Docs',
  url: 'https://docs.clarifai.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.svg',
  organizationName: 'clarifai',
  projectName: 'docs',

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: '/', // Serve the docs at the site's root
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          //editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',         
          //this one also works--editUrl: 'https://github.com/Clarifai/docs/blob/main/',
          editUrl: ({ versionDocsDirPath, docPath }) =>
            `https://github.com/Clarifai/docs/blob/main/${versionDocsDirPath}/${docPath}`,
          docItemComponent: require.resolve('./src/components/CustomDocItem/index.js'),
          docCategoryGeneratedIndexComponent: require.resolve('./src/components/CustomDocCategory/index.js'),
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        googleTagManager: {
          containerId: "GTM-5W9P7GR"
        },
        gtag: {
          trackingID: 'G-3R20NHSS5H',
          anonymizeIP: true,
        },
        sitemap: {
          changefreq: 'weekly',
          priority: 0.5,
          ignorePatterns: ['/tags/**'],
          filename: 'sitemap.xml',
        },
      }),
    ],
    [
      'redocusaurus',
      {
        // Plugin Options for loading OpenAPI files
        specs: [
          // Pass it a path to a local OpenAPI YAML file
          {
            // Redocusaurus will automatically bundle your spec into a single file during the build
            spec: 'static/api-spec/clarifai-v3.json',
            route: '/api-reference',
          },
        ],
        theme: {
          // Change with your site colors
          primaryColor: '#a5b4fc',
        },
        config: path.join(__dirname, 'redocly.yaml'),
      },
    ]
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      algolia: {
        appId: 'E9LMD97ZH2',
        apiKey: 'bb83e0130652ea667b2a9fd12ddb974b',
        indexName: 'clarifai',
        insights: true, // Optional, automatically send insights when user interacts with search results    
        container: 'div',
        debug: false // Set debug to true if you want to inspect the modal

      },
      announcementBar: {
        id: 'support_us_' + Date.now(),
        content:
          '<span>New!</span> Control Center: One Dashboard, Total Control Over Your AI Operations <a target="_blank" rel="noopener noreferrer" href="https://www.clarifai.com/blog/clarifai-11.1-control-center-public-preview-one-dashboard-total-control-over-your-ai-operations">read now</a>',
        isCloseable: false,
      },
      navbar: {
        title: '',
        logo: {
          alt: 'Clarifai Docs',
          src: 'img/logo-dark.svg',
          srcDark: 'img/logo-light.svg',
          href: '/',
        },
        items: [
          {
            type: "dropdown",
            label: "Portal Guide",
            position: "left",
            items: [
              {
                label: "Basics",
                to: "/clarifai-basics/start-here-5-mins-or-less"
              },
              {
                label: "Exploring Your Data",
                to: "/portal-guide/inputs-manager/",
              },
              {
                label: "Creating Concepts",
                to: "/portal-guide/inputs-manager/concepts"
              },
              {
                label: "Search Your Data",
                to: "/portal-guide/psearch"
              },
              {
                label: "Label Your Data",
                to: "/portal-guide/inputs-manager/annotate"
              },
              {
                label: "Handling Datasets",
                to: "/portal-guide/datasets",
              },
              {
                label: "Try an AI Model",
                to: "/portal-guide/ppredict",
              },
              {
                label: "Train Your Own Model",
                to: "/portal-guide/model",
              },
              {
                label: "Compute Orchestration",
                to: "/portal-guide/compute-orchestration",
              },
              {
                label: "Create Workflows",
                to: "/portal-guide/workflows",
              },
              {
                label: "Develop UI Modules",
                to: "/portal-guide/modules",
              },
              {
                label: "Manage Your Orgs and Teams",
                to: "/portal-guide/clarifai-organizations/",
              },
              {
                label: "Tutorials",
                to: "/tutorials/node-js-tutorial"
              }
            ]
          },
          {
            type: "dropdown",
            label: "SDK Guide",
            position: "left",
            items: [
              {
                label: "Python SDK",
                to: "/sdk/python-installation",
              },
              {
                label: "Clarifai CLI",
                to: "/sdk/cli",
              },
              {
                label: "Node.js SDK",
                to: "/sdk/node-js-installation"
              },
              {
                label: "Integrations",
                to: "/integrations/langchain",
              },
              {
                label: "Python SDK Notebooks",
                to: '/sdk/notebook-examples'
              }
            ]
          },
          {
            type: "dropdown",
            label: "API Reference Guide",
            position: "left",
            items: [
              {
                label: 'API Client Guide',
                to: '/api-guide/api-overview/api-clients',
              },
              {
                label: 'API Reference Guide',
                to: "/api-reference",
                rel: "noopener"
              },
              {
                label: 'API Guide in Postman',
                to: 'https://documenter.getpostman.com/view/30622694/2s9YkuZdro',
                target: "_blank",
                rel: "noopener"
              }
            ]
          },
          {
            type: "dropdown",
            label: "Releases",
            position: "left",
            items: [
              {
                label: "Upcoming Platform Changes",
                to: "/product-updates/upcoming-api-changes",
              },
              {
                label: "Changelog",
                to: "/product-updates/changelog"
              }
            ]
          },
          //{
            // type: "",
            //label: "Product Roadmap",
            //position: "left",
            //href: "https://portal.productboard.com/bd1rxfuyfbu6vqnmkva3mprx/tabs/1-under-consideration"
          //},
          {
            type: 'search',
            position: 'right',
          },
          // {
          //   href: 'https://documenter.getpostman.com/view/30622694/2s9YkuZdro',
          //   className: "header-postman-link",
          //   position: 'right',
          //   'aria-label': 'Postman Docs',
          // },
          {
            href: 'https://github.com/Clarifai/docs',
            className: "header-github-link",
            position: 'right',
            'aria-label': 'Github repository'
          },
          {
            href: 'https://discord.gg/WgUvPK4pVD',
            className: 'header-discord-link',
            position: 'right',
            'aria-label': 'Discord'
          },
          {
            label: 'Get Started',
            href: "https://clarifai.com/explore",
            className: 'header-primary-cta-link',
            position: 'right',
            'aria-label': 'Get started'
          },
          // {
          //   href: 'https://api.clarifai.com/api-doc/?url=https://api.clarifai.com/v2/swagger.json',
          //   label: 'Swagger API Guide',
          //    position: 'right',
          //  }
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Company',
            items: [
              {
                label: 'Clarifai Website',
                href: 'https://clarifai.com',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Stack Overflow',
                href: 'https://stackoverflow.com/questions/tagged/clarifai',
              },
              {
                label: 'Slack',
                href: 'https://join.slack.com/t/clarifaicommunity/shared_invite/zt-1jehqesme-l60djcd3c_4a1eCV~uPUjQ',
              },
              {
                label: 'Twitter',
                href: 'https://twitter.com/clarifai',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'LinkedIn',
                href: 'https://www.linkedin.com/company/clarifai',
              },
              {
                label: 'GitHub',
                href: 'https://github.com/facebook/docusaurus',
              },
              {
                label: 'Facebook',
                href: 'https://www.facebook.com/Clarifai/',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Clarifai, Inc.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
        // Issue with docusaurus & Redocusaurus on loading the code theme
        // Reference: https://github.com/PrismJS/prism/issues/3458#issuecomment-1134426181
        additionalLanguages: ['php', 'java', 'csharp', 'objectivec', 'bash', 'scala'],
      },
      colorMode: {
        defaultMode: 'dark',
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      docs: {
        sidebar: {
          hideable: true
        }
      }
    }),
  plugins: [
    //[
    //require.resolve("@cmfcmf/docusaurus-search-local"),
    //{
    // Options here
    //indexBlog: false,
    // },
    // ],
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            to: '/clarifai-basics/start-here-5-mins-or-less',
            from: ['/data-labeling-services/labeling-services']
          },
          {
            to: '/api-guide/search/',
            from: ['/api-guide/search/legacy-search/']
          },
          {
            to: '/sdk/node-api-reference',
            from: ['/nodejs-sdk/api-reference'],
          },
          {
            to: '/sdk/python-installation',
            from: ['/python-sdk/sdk-overview'],
          },
          {
            to: '/sdk/api-reference',
            from: ['/python-sdk/api-reference'],
          },
          {
            to: '/sdk/create-apps',
            from: ['/python-sdk/create-apps'],
          },
          {
            to: '/sdk/managing-datasets',
            from: ['/python-sdk/managing-datasets'],
          },
          {
            to: '/sdk/managing-inputs',
            from: ['/python-sdk/managing-inputs'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/',
            from: ['/python-sdk/Inference-from-AI-Models/'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/Image-as-Input',
            from: ['/python-sdk/Inference-from-AI-Models/Image-as-Input'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/Text-as-Input',
            from: ['/python-sdk/Inference-from-AI-Models/Text-as-Input'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/Audio-as-Input',
            from: ['/python-sdk/Inference-from-AI-Models/Audio-as-Input'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/Multimodal-as-Input',
            from: ['/python-sdk/Inference-from-AI-Models/Multimodal-as-Input'],
          },
          {
            to: '/sdk/Inference-from-AI-Models/Advance-Inference-Options',
            from: ['/python-sdk/Inference-from-AI-Models/Advance-Inference-Options'],
          },
          {
            to: '/sdk/Building-Workflow-Graphs/',
            from: ['/python-sdk/Building-Workflow-Graphs/'],
          },
          {
            to: '/sdk/Building-Workflow-Graphs/Inference-from-Workflows/',
            from: ['/python-sdk/Building-Workflow-Graphs/Inference-from-Workflows/'],
          },
          {
            to: '/sdk/model-train-and-eval',
            from: ['/python-sdk/model-train-and-eval'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/',
            from: ['/python-sdk/Model-Training-Tutorial/'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/clusterer',
            from: ['/python-sdk/Model-Training-Tutorial/clusterer'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/embedding_classifier',
            from: ['/python-sdk/Model-Training-Tutorial/embedding_classifier'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/text_classifier',
            from: ['/python-sdk/Model-Training-Tutorial/text_classifier'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/text_to_text',
            from: ['/python-sdk/Model-Training-Tutorial/text_to_text'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/visual_classifier',
            from: ['/python-sdk/Model-Training-Tutorial/visual_classifier'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/visual_detector',
            from: ['/python-sdk/Model-Training-Tutorial/visual_detector'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/visual_embedder',
            from: ['/python-sdk/Model-Training-Tutorial/visual_embedder'],
          },
          {
            to: '/sdk/Model-Training-Tutorial/visual_segmenter',
            from: ['/python-sdk/Model-Training-Tutorial/visual_segmenter'],
          },
          {
            to: '/sdk/Search/',
            from: ['/python-sdk/Search/'],
          },
          {
            to: '/sdk/Search/Ranks',
            from: ['/python-sdk/Search/Ranks'],
          },
          {
            to: '/sdk/Search/Filter',
            from: ['/python-sdk/Search/Filter'],
          },
          {
            to: '/sdk/Search/Advance-Search',
            from: ['/python-sdk/Search/Advance-Search'],
          },
          {
            to: '/sdk/advance-model-operations/',
            from: ['/python-sdk/advance-model-operations/'],
          },
          {
            to: '/sdk/advance-model-operations/model-export',
            from: ['/python-sdk/advance-model-operations/model-export'],
          },
          {
            to: '/sdk/rag',
            from: ['/python-sdk/rag'],
          },
          {
            to: '/sdk/notebook-examples',
            from: ['/python-sdk/notebook-examples'],
          },
          {
            to: '/api-guide/data/create-get-update-delete',
            from: '/api-guide/data/cloud-storage'
          },
          {
            to: '/portal-guide/psearch/',
            from: '/portal-guide/psearch/psaved_searches'
          },
          {
            to: '/glossary/general-ai',
            from: '/clarifai-basics/glossary/'
          },
          {
            to: '/glossary/generative-ai',
            from: '/clarifai-basics/glossary/generative-ai'
          },
          {
            to: '/sdk/advanced-concept-management',
            from: '/sdk/advanced-concept management'
          },
          {
            to: '/portal-guide/labeling-tasks/review',
            from: '/portal-guide/annotate/workforce-management'
          },
          {
            to: '/portal-guide/control-center',
            from: '/portal-guide/usage-dashboard'
          },
          {
            to: '/portal-guide/model/text-classifiers-transfer-learn',
            from: '/portal-guide/workflows/common-workflows/custom-text-walkthrough'
          },
          {
            to: '/portal-guide/workflows/working-with-workflows',
            from: '/portal-guide/workflows/input-nodes'
          },
          {
            to: '/portal-guide/workflows/working-with-workflows',
            from: '/portal-guide/workflows/workflow-builder'
          },
          {
            to: '/portal-guide/workflows/working-with-workflows',
            from: '/portal-guide/workflows/setting-up-a-mesh-workflow'
          },
          {
            to: '/portal-guide/inputs-manager/',
            from: '/portal-guide/data/'
          },
          {
            to: '/portal-guide/inputs-manager/supported-formats/',
            from: '/portal-guide/data/supported-formats/'
          },
          {
            to: '/portal-guide/inputs-manager/',
            from: '/portal-guide/data/explorer/'
          },
          {
            to: '/portal-guide/inputs-manager/bulk-labeling/',
            from: '/portal-guide/data/explorer/bulk-labeling/'
          },
          {
            to: '/portal-guide/inputs-manager/concepts',
            from: '/portal-guide/concepts/'
          },
          {
            to: '/portal-guide/inputs-manager/concepts',
            from: '/portal-guide/concepts/create-get-update-delete/'
          },
          {
            to: '/portal-guide/inputs-manager/annotate/',
            from: '/portal-guide/annotate/create-get-update-delete'
          },
          {
            to: '/portal-guide/input-viewer/predictions/',
            from: '/portal-guide/data/explorer/predictions'
          },





          
          {
            to: '/portal-guide/input-viewer/annotate',
            from: '/portal-guide/explorer/annotations'
          },
          {
            to: '/portal-guide/input-viewer/object-tracking',
            from: '/portal-guide/data/explorer/object-tracking/'
          },
          {
            to: '/portal-guide/input-viewer/annotate',
            from: '/portal-guide/data/explorer/annotations/'
          },
          {
            to: '/portal-guide/input-viewer/annotate',
            from: '/portal-guide/annotate/label-types'
          },
          {
            to: '/portal-guide/input-viewer/ai-assist',
            from: '/portal-guide/annotate/ai-assist'
          },
          {
            to: '/portal-guide/labeling-tasks/',
            from: '/portal-guide/annotate/'
          },
          {
            to: '/portal-guide/labeling-tasks/create-a-task',
            from: '/portal-guide/annotate/create-a-task'
          },
          {
            to: '/portal-guide/labeling-tasks/auto-annotation',
            from: '/portal-guide/annotate/auto-annotation'
          },
          {
            to: '/portal-guide/labeling-tasks/review',
            from: '/portal-guide/annotate/review'
          },
          {
            to: '/portal-guide/labeling-tasks/labeling-tools',
            from: '/portal-guide/annotate/labeling-tools'
          },
          {
            to: '/portal-guide/labeling-tasks/positive-and-negative-annotations',
            from: '/portal-guide/annotate/positive-and-negative-annotations'
          },
          {
            to: '/portal-guide/modules/collectors',
            from: '/portal-guide/data/collectors'
          },
          {
            to: '/portal-guide/portal-overview/languages',
            from: '/portal-guide/concepts/languages'
          },
          {
            to: '/portal-guide/model/training-data',
            from: '/portal-guide/annotate/training-data'
          },
          {
            to: '/portal-guide/modules/hyperparameter-sweeps',
            from: '/portal-guide/model/hyperparameter-sweeps'
          },
          {
            to: '/api-guide/workflows/workflow-predict',
            from: '/api-guide/workflows/common-workflows/workflow-predict'
          },
          {
            to: '/portal-guide/input-viewer/annotate',
            from: '/portal-guide/input-viewer/label-types'
          },
          {
            to: '/portal-guide/compute-orchestration/cloud-instances',
            from: '/portal-guide/compute-orchestration/instance-types'
          },
          {
            to: '/sdk/compute-orchestration/model-upload',
            from: '/sdk/advance-model-operations/model-upload'
          },
          {
            to: '/sdk/compute-orchestration/model-upload',
            from: '/api-guide/model/import-model/'
          },
          {
            to: '/api-guide/api-overview/status-codes',
            from: '/api-guide/advanced-topics/status-codes'
          },
          {
            to: '/api-guide/api-overview/pagination',
            from: '/api-guide/advanced-topics/pagination/'
          },

        ],
        createRedirects(existingPath) {
          if (existingPath.includes('/community')) {
            // Redirect from /community/X to /portal-guide/X
            return existingPath.replace('/community', '/portal-guide');
          }
          return undefined; // Return a falsy value: no redirect created
        },
      },
    ],
  ],
  scripts: [
    {
      src: "/scripts/sidebar.js",
      async: true,
    },
    {
      src: "/scripts/intercomConfig.js",
      async: true,
    }
  ],
};

module.exports = config;