From f978782b019737162ca567021c027d246151b4aa Mon Sep 17 00:00:00 2001
From: Crphang <crphang@gmail.com>
Date: Sat, 13 Jul 2019 17:02:38 +0800
Subject: [PATCH 1/4] Add google analytics plugin

---
 src/plugins/googleAnalytics.js | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 src/plugins/googleAnalytics.js

diff --git a/src/plugins/googleAnalytics.js b/src/plugins/googleAnalytics.js
new file mode 100644
index 0000000000..8f1bd5094d
--- /dev/null
+++ b/src/plugins/googleAnalytics.js
@@ -0,0 +1,17 @@
+function getGoogleAnalyticsTrackingCode(pluginContext) {
+  return `
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=${pluginContext.trackingID}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+    
+      gtag('config', '${pluginContext.trackingID}');
+    </script>`;
+}
+
+module.exports = {
+  // eslint-disable-next-line no-unused-vars
+  getScripts: (content, pluginContext, frontMatter, utils) => getGoogleAnalyticsTrackingCode(pluginContext),
+};

From d0b0a2faab3a0446c31e409db3fa522f4f5ba5fb Mon Sep 17 00:00:00 2001
From: Crphang <crphang@gmail.com>
Date: Sun, 14 Jul 2019 18:32:45 +0800
Subject: [PATCH 2/4] Add functional test to google analytics plugin

---
 .../test_site/expected/bugs/index.html         | 13 +++++++++++++
 test/functional/test_site/expected/index.html  | 13 +++++++++++++
 .../test_site/expected/sub_site/index.html     | 13 +++++++++++++
 .../test_site/expected/testAfterSetup.html     | 13 +++++++++++++
 .../expected/testAnchorGeneration.html         | 13 +++++++++++++
 .../test_site/expected/testAntiFOUCStyles.html | 13 +++++++++++++
 .../expected/testEmptyFrontmatter.html         | 13 +++++++++++++
 .../expected/testExternalScripts.html          | 13 +++++++++++++
 .../test_site/expected/testLayouts.html        | 13 +++++++++++++
 .../expected/testLayoutsOverride.html          | 13 +++++++++++++
 .../test_site/expected/testPlantUML.html       | 13 +++++++++++++
 .../test_site/expected/testThumbnails.html     | 13 +++++++++++++
 .../test_site/expected/testTooltipSpacing.html | 13 +++++++++++++
 .../test_site/expected/test_md_fragment.html   | 13 +++++++++++++
 test/functional/test_site/site.json            |  6 +++++-
 .../test_site/testGoogleAnalytics.md           | 18 ++++++++++++++++++
 16 files changed, 205 insertions(+), 1 deletion(-)
 create mode 100644 test/functional/test_site/testGoogleAnalytics.md

diff --git a/test/functional/test_site/expected/bugs/index.html b/test/functional/test_site/expected/bugs/index.html
index abdccb135d..c8f0ceb0ba 100644
--- a/test/functional/test_site/expected/bugs/index.html
+++ b/test/functional/test_site/expected/bugs/index.html
@@ -107,6 +107,19 @@ <h2 id="remove-extra-space-in-links">Remove extra space in links<a class="fa fa-
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="../markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/index.html b/test/functional/test_site/expected/index.html
index 610c3d5ac1..b4a00916b2 100644
--- a/test/functional/test_site/expected/index.html
+++ b/test/functional/test_site/expected/index.html
@@ -658,6 +658,19 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/sub_site/index.html b/test/functional/test_site/expected/sub_site/index.html
index 3ad3495133..497ef260e6 100644
--- a/test/functional/test_site/expected/sub_site/index.html
+++ b/test/functional/test_site/expected/sub_site/index.html
@@ -59,6 +59,19 @@ <h2 id="feature-list">Feature list<a class="fa fa-anchor" href="#feature-list"><
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="../markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testAfterSetup.html b/test/functional/test_site/expected/testAfterSetup.html
index f5c758910f..439c34d3d9 100644
--- a/test/functional/test_site/expected/testAfterSetup.html
+++ b/test/functional/test_site/expected/testAfterSetup.html
@@ -53,6 +53,19 @@
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/testAfterSetup/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testAnchorGeneration.html b/test/functional/test_site/expected/testAnchorGeneration.html
index e5a48e2444..ba02455fdd 100644
--- a/test/functional/test_site/expected/testAnchorGeneration.html
+++ b/test/functional/test_site/expected/testAnchorGeneration.html
@@ -109,6 +109,19 @@ <h6 id="should-have-anchor-24">should have anchor<a class="fa fa-anchor" href="#
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testAntiFOUCStyles.html b/test/functional/test_site/expected/testAntiFOUCStyles.html
index c9a278d380..769090ccde 100644
--- a/test/functional/test_site/expected/testAntiFOUCStyles.html
+++ b/test/functional/test_site/expected/testAntiFOUCStyles.html
@@ -80,6 +80,19 @@ <h1 id="filler-text">Filler text<a class="fa fa-anchor" href="#filler-text"></a>
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testEmptyFrontmatter.html b/test/functional/test_site/expected/testEmptyFrontmatter.html
index 04616b095a..67ac651e08 100644
--- a/test/functional/test_site/expected/testEmptyFrontmatter.html
+++ b/test/functional/test_site/expected/testEmptyFrontmatter.html
@@ -50,6 +50,19 @@
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testExternalScripts.html b/test/functional/test_site/expected/testExternalScripts.html
index be3f2e4dc8..5d8e20776c 100644
--- a/test/functional/test_site/expected/testExternalScripts.html
+++ b/test/functional/test_site/expected/testExternalScripts.html
@@ -54,6 +54,19 @@
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testLayouts.html b/test/functional/test_site/expected/testLayouts.html
index f1f3b686bd..e4f87d66ea 100644
--- a/test/functional/test_site/expected/testLayouts.html
+++ b/test/functional/test_site/expected/testLayouts.html
@@ -57,6 +57,19 @@ <h1 id="uses-a-front-matter-layout">Uses a front matter layout<a class="fa fa-an
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/testLayout/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testLayoutsOverride.html b/test/functional/test_site/expected/testLayoutsOverride.html
index e69b908773..330d2c6ac6 100644
--- a/test/functional/test_site/expected/testLayoutsOverride.html
+++ b/test/functional/test_site/expected/testLayoutsOverride.html
@@ -57,6 +57,19 @@ <h1 id="uses-a-site-json-layout-overriding-front-matter">Uses a site.json layout
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/testLayout/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testPlantUML.html b/test/functional/test_site/expected/testPlantUML.html
index 3d158cbf5e..095c38fca7 100644
--- a/test/functional/test_site/expected/testPlantUML.html
+++ b/test/functional/test_site/expected/testPlantUML.html
@@ -78,6 +78,19 @@ <h3 id="object-diagram">Object Diagram<a class="fa fa-anchor" href="#object-diag
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testThumbnails.html b/test/functional/test_site/expected/testThumbnails.html
index f92f1ae23d..efe4a3e8ee 100644
--- a/test/functional/test_site/expected/testThumbnails.html
+++ b/test/functional/test_site/expected/testThumbnails.html
@@ -167,6 +167,19 @@ <h3 id="font-color">font-color<a class="fa fa-anchor" href="#font-color"></a></h
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/testTooltipSpacing.html b/test/functional/test_site/expected/testTooltipSpacing.html
index 75ba25d26c..91cdd23411 100644
--- a/test/functional/test_site/expected/testTooltipSpacing.html
+++ b/test/functional/test_site/expected/testTooltipSpacing.html
@@ -58,6 +58,19 @@ <h1 id="569-stray-space-after-tooltip">569: Stray space after tooltip<a class="f
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/expected/test_md_fragment.html b/test/functional/test_site/expected/test_md_fragment.html
index 14dd398e10..c1c5edbd2d 100644
--- a/test/functional/test_site/expected/test_md_fragment.html
+++ b/test/functional/test_site/expected/test_md_fragment.html
@@ -51,6 +51,19 @@ <h1 id="some-heading">Some heading<a class="fa fa-anchor" href="#some-heading"><
 <script>
   alert("hello")
 </script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
 <script src="markbind/layouts/default/scripts.js"></script>
 
 </html>
\ No newline at end of file
diff --git a/test/functional/test_site/site.json b/test/functional/test_site/site.json
index 91c2460049..c094b7d3ac 100644
--- a/test/functional/test_site/site.json
+++ b/test/functional/test_site/site.json
@@ -86,7 +86,8 @@
   "headingIndexingLevel": 4,
   "plugins": [
     "testMarkbindPlugin",
-    "filterTags"
+    "filterTags",
+    "googleAnalytics"
   ],
   "pluginsContext": {
     "testMarkbindPlugin": {
@@ -95,6 +96,9 @@
     },
     "filterTags": {
       "tags": ["tag-site-shown", "+tag-site-override-shown", "+tag-site-override-specific-shown"]
+    },
+    "googleAnalytics": {
+      "trackingID": "TRACKING-ID"
     }
   }
 }
diff --git a/test/functional/test_site/testGoogleAnalytics.md b/test/functional/test_site/testGoogleAnalytics.md
new file mode 100644
index 0000000000..cae4a500c5
--- /dev/null
+++ b/test/functional/test_site/testGoogleAnalytics.md
@@ -0,0 +1,18 @@
+# Test Google Analytics Plugin
+
+Following script should be included:
+
+```js
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+  gtag('js', new Date());
+
+  gtag('config', 'TRACKING-ID');
+</script>
+```
\ No newline at end of file

From 34e0f63ccf6b7cdfe59db13341c867c8d4c5e858 Mon Sep 17 00:00:00 2001
From: Crphang <crphang@gmail.com>
Date: Sun, 4 Aug 2019 16:58:16 +0800
Subject: [PATCH 3/4] Remove diagrams and fix user guide

---
 docs/userGuide/plugins/googleAnalytics.mbdf   | 24 +++++++++++++++++++
 docs/userGuide/usingPlugins.md                |  3 ++-
 .../test_site/testGoogleAnalytics.md          | 18 --------------
 3 files changed, 26 insertions(+), 19 deletions(-)
 create mode 100644 docs/userGuide/plugins/googleAnalytics.mbdf
 delete mode 100644 test/functional/test_site/testGoogleAnalytics.md

diff --git a/docs/userGuide/plugins/googleAnalytics.mbdf b/docs/userGuide/plugins/googleAnalytics.mbdf
new file mode 100644
index 0000000000..0cbbaf28a3
--- /dev/null
+++ b/docs/userGuide/plugins/googleAnalytics.mbdf
@@ -0,0 +1,24 @@
+#### `Google Analytics`: Enhancing site with Google Analytics
+
+This plugin allows your web pages to be enhanced with [google analytics](https://analytics.google.com/analytics/web/#/) to track, analyse and improve your content..
+
+To enable it, add `googleAnalytics` to your site's plugins, and add the trackingID parameter via the `pluginsContext`.
+
+Name | Type | Default | Description
+---- | ---- | ------- | ------
+trackingID | `String` || Tracking ID provided by Google. Follow this [guide](https://support.google.com/analytics/answer/1008080) to get your Tracking ID.
+
+```js
+site.json
+{
+  ...
+  "plugins": [
+    "googleAnalytics"
+  ],
+  "pluginsContext": {
+    "googleAnalytics": {
+      "trackingID": "YOUR-TRACKING-ID", // replace with your google analytics tracking id.
+    }
+  }
+}
+```
diff --git a/docs/userGuide/usingPlugins.md b/docs/userGuide/usingPlugins.md
index 722612bdce..e306a8239c 100644
--- a/docs/userGuide/usingPlugins.md
+++ b/docs/userGuide/usingPlugins.md
@@ -171,8 +171,9 @@ Disabling the `anchors` plugin:
 
 MarkBind has a set of built-in plugins that can be used immediately without installation.
 
-<include src="plugins/filterTags.mbdf" />
 <include src="plugins/algolia.mbdf" />
+<include src="plugins/filterTags.mbdf" />
+<include src="plugins/googleAnalytics.mbdf" />
 
 {% from "njk/common.njk" import previous_next %}
 {{ previous_next('usingHtmlJavaScriptCss', 'tweakingThePageStructure') }}
diff --git a/test/functional/test_site/testGoogleAnalytics.md b/test/functional/test_site/testGoogleAnalytics.md
deleted file mode 100644
index cae4a500c5..0000000000
--- a/test/functional/test_site/testGoogleAnalytics.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# Test Google Analytics Plugin
-
-Following script should be included:
-
-```js
-<!-- Global site tag (gtag.js) - Google Analytics -->
-<script async src="https://www.googletagmanager.com/gtag/js?id=TRACKING-ID"></script>
-<script>
-  window.dataLayer = window.dataLayer || [];
-
-  function gtag() {
-    dataLayer.push(arguments);
-  }
-  gtag('js', new Date());
-
-  gtag('config', 'TRACKING-ID');
-</script>
-```
\ No newline at end of file

From c964a881c018c5c289eb008f29664f19dbe134fe Mon Sep 17 00:00:00 2001
From: Crphang <crphang@gmail.com>
Date: Sun, 4 Aug 2019 16:58:48 +0800
Subject: [PATCH 4/4] Fix user guide

---
 docs/userGuide/plugins/googleAnalytics.mbdf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/userGuide/plugins/googleAnalytics.mbdf b/docs/userGuide/plugins/googleAnalytics.mbdf
index 0cbbaf28a3..a6da8457ed 100644
--- a/docs/userGuide/plugins/googleAnalytics.mbdf
+++ b/docs/userGuide/plugins/googleAnalytics.mbdf
@@ -1,6 +1,6 @@
 #### `Google Analytics`: Enhancing site with Google Analytics
 
-This plugin allows your web pages to be enhanced with [google analytics](https://analytics.google.com/analytics/web/#/) to track, analyse and improve your content..
+This plugin allows your web pages to be enhanced with [google analytics](https://analytics.google.com/analytics/web/#/) to track, analyse and improve your content.
 
 To enable it, add `googleAnalytics` to your site's plugins, and add the trackingID parameter via the `pluginsContext`.