jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove google-analytics

Browse source 
This was deprecated in https://github.com/rust-lang/mdBook/pull/1675 in
2021.

Closes https://github.com/rust-lang/mdBook/issues/2720
This commit is contained in:
Eric Huss 2025-07-26 08:15:37 -07:00
parent cf7762f57f
commit aef12bbb20
5 changed files with 0 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
crates/mdbook-core/src/config.rs
View file

@ -528,8 +528,6 @@ pub struct HtmlConfig {
pub mathjax_support: bool, pub mathjax_support: bool,
/// Whether to fonts.css and respective font files to the output directory. /// Whether to fonts.css and respective font files to the output directory.
pub copy_fonts: bool, 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>`. /// Additional CSS stylesheets to include in the rendered page's `<head>`.
pub additional_css: Vec<PathBuf>, pub additional_css: Vec<PathBuf>,
/// Additional JS scripts to include at the bottom of the rendered page's /// Additional JS scripts to include at the bottom of the rendered page's
@ -593,7 +591,6 @@ impl Default for HtmlConfig {
curly_quotes: false, curly_quotes: false,
mathjax_support: false, mathjax_support: false,
copy_fonts: true, copy_fonts: true,
google_analytics: None,
additional_css: Vec::new(), additional_css: Vec::new(),
additional_js: Vec::new(), additional_js: Vec::new(),
fold: Fold::default(), fold: Fold::default(),
@ -811,7 +808,6 @@ mod tests {
theme = "./themedir" theme = "./themedir"
default-theme = "rust" default-theme = "rust"
smart-punctuation = true smart-punctuation = true
google-analytics = "123456"
additional-css = ["./foo/bar/baz.css"] additional-css = ["./foo/bar/baz.css"]
git-repository-url = "https://foo.com/" git-repository-url = "https://foo.com/"
git-repository-icon = "fa-code-fork" git-repository-icon = "fa-code-fork"
@ -858,7 +854,6 @@ mod tests {
}; };
let html_should_be = HtmlConfig { let html_should_be = HtmlConfig {
smart_punctuation: true, smart_punctuation: true,
google_analytics: Some(String::from("123456")),
additional_css: vec![PathBuf::from("./foo/bar/baz.css")], additional_css: vec![PathBuf::from("./foo/bar/baz.css")],
theme: Some(PathBuf::from("./themedir")), theme: Some(PathBuf::from("./themedir")),
default_theme: Some(String::from("rust")), 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` destination = "my-book" # the output files will be generated in `root/my-book` instead of `root/book`
theme = "my-theme" theme = "my-theme"
smart-punctuation = true smart-punctuation = true
google-analytics = "123456"
additional-css = ["custom.css", "custom2.css"] additional-css = ["custom.css", "custom2.css"]
additional-js = ["custom.js"] additional-js = ["custom.js"]
"#; "#;
@ -1047,7 +1041,6 @@ mod tests {
let html_should_be = HtmlConfig { let html_should_be = HtmlConfig {
theme: Some(PathBuf::from("my-theme")), theme: Some(PathBuf::from("my-theme")),
smart_punctuation: true, smart_punctuation: true,
google_analytics: Some(String::from("123456")),
additional_css: vec![PathBuf::from("custom.css"), PathBuf::from("custom2.css")], additional_css: vec![PathBuf::from("custom.css"), PathBuf::from("custom2.css")],
additional_js: vec![PathBuf::from("custom.js")], additional_js: vec![PathBuf::from("custom.js")],
..Default::default() ..Default::default()

10
crates/mdbook-driver/src/mdbook.rs
View file

@ -65,16 +65,6 @@ impl MDBook {
config.update_from_env(); config.update_from_env();
if let Some(html_config) = config.html_config() { 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 { if html_config.curly_quotes {
warn!( warn!(
"The output.html.curly-quotes field has been renamed to \ "The output.html.curly-quotes field has been renamed to \

19
crates/mdbook-html/front-end/templates/index.hbs
View file

@ -275,25 +275,6 @@
</script> </script>
{{/if}} {{/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}} {{#if playground_line_numbers}}
<script> <script>
window.playground_line_numbers = true; window.playground_line_numbers = true;

5
crates/mdbook-html/src/html_handlebars/hbs_renderer.rs
View file

@ -552,11 +552,6 @@ fn make_data(
json!(preferred_dark_theme), 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 { if html_config.mathjax_support {
data.insert("mathjax_support".to_owned(), json!(true)); data.insert("mathjax_support".to_owned(), json!(true));
} }

2
guide/src/format/configuration/renderers.md
View file

@ -132,8 +132,6 @@ The following configuration options are available:
If `false`, the built-in fonts will not be used. If `false`, the built-in fonts will not be used.
This option is deprecated. If you want to define your own custom fonts, 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. 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 - **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 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 will be loaded after the default ones where you can surgically change the