feat: enable google analytics with _googleAnalyticsTagId (#8733)

* feat: enable google analytics with _googleAnalyticsTagId * test(snapshot): update snapshots for 3d7f25d --------- Co-authored-by: yufeih <[email protected]>
dotnet · May 5, 2023 · bc93339 · bc93339
1 parent 2fb03c1
commit bc93339
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 2 deletions.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -30,7 +30,8 @@
     "globalMetadata": {
       "_appTitle": "docfx",
       "_appName": "docfx",
-      "_appFooter": "<span>Supported by the <a href=\"https://dotnetfoundation.org\">.NET Foundation</a>. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>"
+      "_appFooter": "<span>Supported by the <a href=\"https://dotnetfoundation.org\">.NET Foundation</a>. Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></span>",
+      "_googleTagId": "G-Q5N6XJHEX5"
     },
     "output": "_site",
     "template": [

diff --git a/docs/docs/template.md b/docs/docs/template.md
@@ -41,7 +41,8 @@ Name         | Type    | Description
 `_disableNewTab`        | bool    | Whether to render external link indicator icons and open external links in a new tab.
 `_disableNextArticle`   | bool    | Whether to show the previous and next article link.
 `_disableTocFilter`     | bool    | Whether to show the table of content filter box.
-`lang`                 | string | Primary language of the page. If unset, the `<html>` tag will not have `lang` property.
+`_googleTagId`          | string  | Enables Google Analytics web traffic analysis.
+`lang`                  | string  | Primary language of the page. If unset, the `<html>` tag will not have `lang` property.
 `layout`                | string  | Determines the layout of the page. Supported values are `landing` and `chromeless`.
 
 # [Default Template](#tab/default)

diff --git a/templates/modern/layout/_master.tmpl b/templates/modern/layout/_master.tmpl
@@ -39,6 +39,16 @@
     {{/redirect_url}}
   </head>
 
+  {{#_googleTagId}}
+  <script async src="https://www.googletagmanager.com/gtag/js?id={{_googleTagId}}"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag() { dataLayer.push(arguments); }
+    gtag('js', new Date());
+    gtag('config', '{{_googleTagId}}');
+  </script>
+  {{/_googleTagId}}
+
   {{^redirect_url}}
   <body class="tex2jax_ignore" data-layout="{{layout}}" data-yaml-mime="{{yamlmime}}">
     <header class="bg-body border-bottom">

diff --git a/...x.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html b/...x.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html
@@ -205,6 +205,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/...fx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/...fx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html
@@ -205,6 +205,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/...docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/...docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html
@@ -205,6 +205,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference" data-search="true">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html
@@ -205,6 +205,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/...pshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html b/...pshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html
@@ -203,6 +203,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/...l/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html b/...l/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html
@@ -203,6 +203,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html
@@ -203,6 +203,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="landing" data-yaml-mime="">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html
@@ -203,6 +203,7 @@
 }
 </style></head>
 
+
   <body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
     <header class="bg-body border-bottom">
       <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">