Remove google-analytics

ehuss · ehuss · commit aef12bbb2023 · 2025-07-26T08:15:37.000-07:00
This was deprecated in #1675 in 2021. Closes #2720
diff --git a/crates/mdbook-core/src/config.rs b/crates/mdbook-core/src/config.rs
@@ -528,8 +528,6 @@ pub struct HtmlConfig {
     pub mathjax_support: bool,
     /// Whether to fonts.css and respective font files to the output directory.
     pub copy_fonts: bool,
-    /// An optional google analytics code.
-    pub google_analytics: Option<String>,
     /// Additional CSS stylesheets to include in the rendered page's `<head>`.
     pub additional_css: Vec<PathBuf>,
     /// Additional JS scripts to include at the bottom of the rendered page's
@@ -593,7 +591,6 @@ impl Default for HtmlConfig {
             curly_quotes: false,
             mathjax_support: false,
             copy_fonts: true,
-            google_analytics: None,
             additional_css: Vec::new(),
             additional_js: Vec::new(),
             fold: Fold::default(),
@@ -811,7 +808,6 @@ mod tests {
         theme = "./themedir"
         default-theme = "rust"
         smart-punctuation = true
-        google-analytics = "123456"
         additional-css = ["./foo/bar/baz.css"]
         git-repository-url = "https://foo.com/"
         git-repository-icon = "fa-code-fork"
@@ -858,7 +854,6 @@ mod tests {
         };
         let html_should_be = HtmlConfig {
             smart_punctuation: true,
-            google_analytics: Some(String::from("123456")),
             additional_css: vec![PathBuf::from("./foo/bar/baz.css")],
             theme: Some(PathBuf::from("./themedir")),
             default_theme: Some(String::from("rust")),
@@ -1022,7 +1017,6 @@ mod tests {
         destination = "my-book" # the output files will be generated in `root/my-book` instead of `root/book`
         theme = "my-theme"
         smart-punctuation = true
-        google-analytics = "123456"
         additional-css = ["custom.css", "custom2.css"]
         additional-js = ["custom.js"]
         "#;
@@ -1047,7 +1041,6 @@ mod tests {
         let html_should_be = HtmlConfig {
             theme: Some(PathBuf::from("my-theme")),
             smart_punctuation: true,
-            google_analytics: Some(String::from("123456")),
             additional_css: vec![PathBuf::from("custom.css"), PathBuf::from("custom2.css")],
             additional_js: vec![PathBuf::from("custom.js")],
             ..Default::default()
diff --git a/crates/mdbook-driver/src/mdbook.rs b/crates/mdbook-driver/src/mdbook.rs
@@ -65,16 +65,6 @@ impl MDBook {
         config.update_from_env();
 
         if let Some(html_config) = config.html_config() {
-            if html_config.google_analytics.is_some() {
-                warn!(
-                    "The output.html.google-analytics field has been deprecated; \
-                     it will be removed in a future release.\n\
-                     Consider placing the appropriate site tag code into the \
-                     theme/head.hbs file instead.\n\
-                     The tracking code may be found in the Google Analytics Admin page.\n\
-                   "
-                );
-            }
             if html_config.curly_quotes {
                 warn!(
                     "The output.html.curly-quotes field has been renamed to \
diff --git a/crates/mdbook-html/front-end/templates/index.hbs b/crates/mdbook-html/front-end/templates/index.hbs
@@ -275,25 +275,6 @@
         </script>
         {{/if}}
 
-        {{#if google_analytics}}
-        <!-- Google Analytics Tag -->
-        <script>
-            const localAddrs = ["localhost", "127.0.0.1", ""];
-
-            // make sure we don't activate google analytics if the developer is
-            // inspecting the book locally...
-            if (localAddrs.indexOf(document.location.hostname) === -1) {
-                (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-                })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
-
-                ga('create', '{{google_analytics}}', 'auto');
-                ga('send', 'pageview');
-            }
-        </script>
-        {{/if}}
-
         {{#if playground_line_numbers}}
         <script>
             window.playground_line_numbers = true;
diff --git a/crates/mdbook-html/src/html_handlebars/hbs_renderer.rs b/crates/mdbook-html/src/html_handlebars/hbs_renderer.rs
@@ -552,11 +552,6 @@ fn make_data(
         json!(preferred_dark_theme),
     );
 
-    // Add google analytics tag
-    if let Some(ref ga) = html_config.google_analytics {
-        data.insert("google_analytics".to_owned(), json!(ga));
-    }
-
     if html_config.mathjax_support {
         data.insert("mathjax_support".to_owned(), json!(true));
     }
diff --git a/guide/src/format/configuration/renderers.md b/guide/src/format/configuration/renderers.md
@@ -132,8 +132,6 @@ The following configuration options are available:
   If `false`, the built-in fonts will not be used.
   This option is deprecated. If you want to define your own custom fonts,
   create a `theme/fonts/fonts.css` file and store the fonts in the `theme/fonts/` directory.
-- **google-analytics:** This field has been deprecated and will be removed in a future release.
-  Use the `theme/head.hbs` file to add the appropriate Google Analytics code instead.
 - **additional-css:** If you need to slightly change the appearance of your book
   without overwriting the whole style, you can specify a set of stylesheets that
   will be loaded after the default ones where you can surgically change the
