config file cleanup

karan925 · karan925 · commit 4db57eef3055 · 2024-01-29T10:46:32.000-08:00
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -3,172 +3,178 @@ import type { Config } from "@docusaurus/types";
 import { themes as prismThemes } from "prism-react-renderer";
 import { EnumChangefreq } from "sitemap";
 
-// const baseUrl = "/docs";
 const baseUrl = "/";
-// const baseUrl = "https://docs.coderabbit.ai/";
 
 const config: Config = {
-    title: "CodeRabbit",
-    staticDirectories: ["public", "static"],
-    tagline: "AI-powered Code Reviews",
-    favicon: "img/favIcon.png",
+  title: "CodeRabbit",
+  staticDirectories: ["public", "static"],
+  tagline: "AI-powered Code Reviews",
+  favicon: "img/favIcon.png",
 
-    // Set the production url of your site here
-    url: "https://coderabbit.ai/",
-    // Set the /<baseUrl>/ pathname under which your site is served
-    // For GitHub pages deployment, it is often '/<projectName>/'
-    baseUrl: baseUrl,
+  // Set the production url of your site here
+  url: "https://coderabbit.ai/",
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: baseUrl,
 
-    // GitHub pages deployment config.
-    // If you aren't using GitHub pages, you don't need these.
-    organizationName: "facebook", // Usually your GitHub org/user name.
-    projectName: "docusaurus", // Usually your repo name.
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: "facebook", // Usually your GitHub org/user name.
+  projectName: "docusaurus", // Usually your repo name.
 
-    onBrokenLinks: "throw",
-    onBrokenMarkdownLinks: "warn",
+  onBrokenLinks: "throw",
+  onBrokenMarkdownLinks: "warn",
 
-    // Even if you don't use internationalization, 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"],
-    },
+  // Even if you don't use internationalization, 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"],
+  },
 
-    plugins: [
-        [
-            "@docusaurus/plugin-client-redirects",
-            {
-                redirects: [
-                    {
-                        to: "https://docs.coderabbit.ai/docs/get-started/signup",
-                        from: "/docs/get-started",
-                    },
-                ],
-            },
-        ],
-        async function myPlugin(context, options) {
-            return {
-                name: "docusaurus-tailwindcss",
-                configurePostCss(postcssOptions) {
-                    // Appends TailwindCSS and AutoPrefixer.
-                    postcssOptions.plugins.push(require("tailwindcss"));
-                    postcssOptions.plugins.push(require("autoprefixer"));
-                    return postcssOptions;
-                },
-            };
-        },
-    ],
-
-    presets: [
-        [
-            "classic",
-            {
-                docs: {
-                    sidebarPath: "./sidebars.ts",
-                    routeBasePath: "/",
-                    breadcrumbs: true,
-                    showLastUpdateTime: true,
-                },
-                blog: {
-                    routeBasePath: "/blog",
-                    showReadingTime: true,
-                },
-                theme: {
-                    customCss: "./src/css/custom.css",
-                },
-                sitemap: {
-                    changefreq: "weekly" as EnumChangefreq,
-                    priority: 0.5,
-                    ignorePatterns: ["/tags/**"],
-                    filename: "sitemap.xml",
-                },
-                googleTagManager: {
-                    containerId: "GTM-5BWLXJRC",
-                },
-            } satisfies Preset.Options,
+  plugins: [
+    [
+      "@docusaurus/plugin-client-redirects",
+      {
+        redirects: [
+          {
+            to: "https://docs.coderabbit.ai/docs/get-started/signup",
+            from: "/docs/get-started",
+          },
         ],
+      },
     ],
+    async function myPlugin(context, options) {
+      return {
+        name: "docusaurus-tailwindcss",
+        configurePostCss(postcssOptions) {
+          // Appends TailwindCSS and AutoPrefixer.
+          postcssOptions.plugins.push(require("tailwindcss"));
+          postcssOptions.plugins.push(require("autoprefixer"));
+          return postcssOptions;
+        },
+      };
+    },
+  ],
 
-    scripts: [
-        "https://buttons.github.io/buttons.js",
-        "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
-        "/docs/js/code-block-buttons.js",
-        `https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js`,
-        {
-            src: "https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js",
-            async: true,
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          sidebarPath: "./sidebars.ts",
+          routeBasePath: "/",
+          breadcrumbs: true,
+          showLastUpdateTime: true,
+        },
+        blog: {
+          blogTitle: "CodeRabbit Blog",
+          blogDescription: "Blog",
+          tagsBasePath: "/tags",
+          editLocalizedFiles: false,
+          routeBasePath: "/blog",
+          showReadingTime: true,
+          blogSidebarCount: "ALL",
+          blogSidebarTitle: "All our posts",
+          blogListComponent: "@theme/BlogListPage",
+          blogPostComponent: "@theme/BlogPostPage",
+        },
+        theme: {
+          customCss: "./src/css/custom.css",
         },
+        sitemap: {
+          changefreq: "weekly" as EnumChangefreq,
+          priority: 0.5,
+          ignorePatterns: ["/tags/**"],
+          filename: "sitemap.xml",
+        },
+        googleTagManager: {
+          containerId: "GTM-5BWLXJRC",
+        },
+      } satisfies Preset.Options,
     ],
+  ],
 
-    themeConfig: {
-        // Replace with your project's social card
-        editUrl: null,
-        colorMode: {
-            defaultMode: "light",
-            disableSwitch: false,
-            respectPrefersColorScheme: false,
+  scripts: [
+    "https://buttons.github.io/buttons.js",
+    "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
+    "/docs/js/code-block-buttons.js",
+    `https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js`,
+    {
+      src: "https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js",
+      async: true,
+    },
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    editUrl: null,
+    colorMode: {
+      defaultMode: "light",
+      disableSwitch: false,
+      respectPrefersColorScheme: false,
+    },
+    docs: {
+      sidebar: {
+        hideable: true,
+      },
+    },
+    metadata: [
+      { name: "keywords", content: "ai, blog" },
+      { name: "twitter:card", content: "summary_large_image" },
+    ],
+    headTags: [
+      // Declare a <link> preconnect tag
+      {
+        tagName: "link",
+        attributes: {
+          rel: "preconnect",
+          href: "https://coderabbit.ai/blog/coderabbit-deep-dive",
         },
-        docs: {
-            sidebar: {
-                hideable: true,
-            },
+      },
+      // Declare some json-ld structured data
+    ],
+    image: "img/docusaurus-social-card.jpg",
+    navbar: {
+      title: "",
+      hideOnScroll: true,
+      logo: {
+        alt: "",
+        src: "img/coderabbit_nav_logo.svg",
+        href: "https://coderabbit.ai",
+      },
+      items: [
+        {
+          type: "docSidebar",
+          docId: "docs",
+          sidebarId: "docsSidebar",
+          position: "left",
+          label: "Docs",
+          href: "https://docs.coderabbit.ai",
+          target: "_self",
         },
-        metadata: [
-            { name: "keywords", content: "ai, blog" },
-            { name: "twitter:card", content: "summary_large_image" },
-        ],
-        headTags: [
-            // Declare a <link> preconnect tag
-            {
-                tagName: "link",
-                attributes: {
-                    rel: "preconnect",
-                    href: "https://coderabbit.ai/blog/coderabbit-deep-dive",
-                },
-            },
-            // Declare some json-ld structured data
-        ],
-        image: "img/docusaurus-social-card.jpg",
-        navbar: {
-            title: "",
-            hideOnScroll: true,
-            logo: {
-                alt: "",
-                src: "img/coderabbit_nav_logo.svg",
-                href: "https://coderabbit.ai",
-            },
-            items: [
-                {
-                    type: "docSidebar",
-                    docId: "docs",
-                    sidebarId: "docsSidebar",
-                    position: "left",
-                    label: "Docs",
-                    href: "https://docs.coderabbit.ai",
-                    target: "_self",
-                },
-                {
-                    // type: "docSidebar",
-                    // sidebarId: "blogsSidebar",
-                    position: "left",
-                    label: "Blog",
-                    href: "https://blog.coderabbit.ai/blog",
-                },
-                {
-                    href: "https://discord.gg/GsXnASn26c",
-                    className: "header-discord-link",
-                    "aria-label": "Discord",
-                    position: "right",
-                    label: "Discord",
-                },
-            ],
+        {
+          // type: "docSidebar",
+          // sidebarId: "blogsSidebar",
+          position: "left",
+          label: "Blog",
+          href: "https://blog.coderabbit.ai/blog",
         },
-        prism: {
-            theme: prismThemes.github,
-            darkTheme: prismThemes.dracula,
+        {
+          href: "https://discord.gg/GsXnASn26c",
+          className: "header-discord-link",
+          "aria-label": "Discord",
+          position: "right",
+          label: "Discord",
         },
-    } satisfies Preset.ThemeConfig,
+      ],
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
 };
 
 export default config;
