feat: add segment to docuaurus (#2247)

gruntwork-io · Dec 12, 2024 · 8d9c1ee · 8d9c1ee
1 parent df6fd6c
commit 8d9c1ee
Show file tree

Hide file tree

Showing 3 changed files with 1,866 additions and 81 deletions.
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -48,6 +48,16 @@ const redirectPlugin = [
 // @ts-ignore - types don't understand the plugin config
 plugins.push(redirectPlugin)
 
+const segmentPlugin = ["@twilio-labs/docusaurus-plugin-segment",
+  {
+    writeKey: "tVYixAoRAiTy0O7hBkB2TH2hMWFm0IW4",
+    allowedInDev: false,
+  }
+];
+
+// @ts-ignore - types don't understand the plugin config
+plugins.push(segmentPlugin);
+
 /** @type {import('@docusaurus/types').FasterConfig} */
 const fasterConfig = {
   rspackBundler: true,
@@ -213,8 +223,8 @@ const config = {
         },
         googleTagManager: enableGoogleAnalytics
           ? {
-              containerId: googleAnalyticsConfig.trackingID,
-            }
+            containerId: googleAnalyticsConfig.trackingID,
+          }
           : undefined,
       },
     ],
@@ -424,20 +434,20 @@ const config = {
       },
       algolia: algoliaConfig
         ? {
-            appId: algoliaConfig.appId,
-            // Public API key: safe to commit, but still sourced from config
-            apiKey: algoliaConfig.apiKey,
-            indexName: algoliaConfig.indexName,
-            libraryIndexName: algoliaConfig.libraryIndexName,
-            contextualSearch: true,
-          }
+          appId: algoliaConfig.appId,
+          // Public API key: safe to commit, but still sourced from config
+          apiKey: algoliaConfig.apiKey,
+          indexName: algoliaConfig.indexName,
+          libraryIndexName: algoliaConfig.libraryIndexName,
+          contextualSearch: true,
+        }
         : undefined,
       zoomSelector: ".markdown :not(em) > img:not(.no-zoom)",
       posthog: enablePosthog
         ? {
-            apiKey: posthogConfig.apiKey,
-            appUrl: posthogConfig.appUrl,
-          }
+          apiKey: posthogConfig.apiKey,
+          appUrl: posthogConfig.appUrl,
+        }
         : undefined,
       metadata: [
         // https://docusaurus.io/docs/2.x/seo#global-metadata

diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
     "@docusaurus/theme-mermaid": "^3.6.0",
     "@mdx-js/react": "^3.0.1",
     "@svgr/webpack": "^5.5.0",
+    "@twilio-labs/docusaurus-plugin-segment": "^0.1.0",
     "@types/jest": "^27.4.0",
     "algoliasearch": "^5.12.0",
     "buffer": "^6.0.3",