feat: analytics support (#1477)

Author: katzino

.github/workflows/deploy.yaml

@@ -14,3 +14,4 @@ jobs:
           env:
             GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
             INTERCOM_APP_ID: ${{ secrets.INTERCOM_APP_ID }}
+            SEGMENT_TOKEN: ${{ secrets.SEGMENT_TOKEN }}

.github/workflows/docs.yaml

@@ -40,6 +40,7 @@ jobs:
                     APIFY_SIGNING_TOKEN: ${{ secrets.APIFY_SIGNING_TOKEN }}
                     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
                     INTERCOM_APP_ID: ${{ secrets.INTERCOM_APP_ID }}
+                    SEGMENT_TOKEN: ${{ secrets.SEGMENT_TOKEN }}
 
             -   name: Set up GitHub Pages
                 uses: actions/configure-pages@v5

.github/workflows/lychee.yml

@@ -33,6 +33,7 @@ jobs:
                     APIFY_SIGNING_TOKEN: ${{ secrets.APIFY_SIGNING_TOKEN }}
                     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
                     INTERCOM_APP_ID: ${{ secrets.INTERCOM_APP_ID }}
+                    SEGMENT_TOKEN: ${{ secrets.SEGMENT_TOKEN }}
 
             -   name: Run Lychee Link Checker
                 id: lychee

.github/workflows/test.yaml

@@ -35,6 +35,7 @@ jobs:
             -   run: npm run build
                 env:
                     INTERCOM_APP_ID: ${{ secrets.INTERCOM_APP_ID }}
+                    SEGMENT_TOKEN: ${{ secrets.SEGMENT_TOKEN }}
 
     lint_content:
         name: Lint markdown content

docusaurus.config.js

@@ -46,6 +46,21 @@ module.exports = {
                 sizes: 'any',
             },
         },
+        // Segment analytics
+        process.env.SEGMENT_TOKEN && {
+            tagName: 'script',
+            innerHTML: `
+                !function(){var i="analytics",analytics=window[i]=window[i]||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","screen","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware","register"];analytics.factory=function(e){return function(){if(window[i].initialized)return window[i][e].apply(window[i],arguments);var n=Array.prototype.slice.call(arguments);if(["track","screen","alias","group","page","identify"].indexOf(e)>-1){var c=document.querySelector("link[rel='canonical']");n.push({__t:"bpc",c:c&&c.getAttribute("href")||void 0,p:location.pathname,u:location.href,s:location.search,t:document.title,r:document.referrer})}n.unshift(e);analytics.push(n);return analytics}};for(var n=0;n<analytics.methods.length;n++){var key=analytics.methods[n];analytics[key]=analytics.factory(key)}analytics.load=function(key,n){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.setAttribute("data-global-segment-analytics-key",i);t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(t,r);analytics._loadOptions=n};analytics._writeKey="FAretQHrDlKZJl9dE9xRgH2ia0a4ACXB";;analytics.SNIPPET_VERSION="5.2.0";
+                    analytics.load("${process.env.SEGMENT_TOKEN}");
+                    analytics.page({
+                        app: 'docs',
+                        pageType: 'DOCS_PAGE',
+                        page_type: 'DOCS_PAGE'
+                    });
+                }}();
+            `,
+            attributes: {},
+        },
         // Intercom messenger
         process.env.INTERCOM_APP_ID && {
             tagName: 'script',