Disable analytics when working local

[Matthijz98]

I am probably missing something but how would i disable parts of my mkdocs.yml when working localy?
I know of the group plugin but that only works in the plugins part of the config file?

I could override the analytics js to add a simple check but feels a bid hacky.

[alexvoss]

One option if you cannot solve this with environment variables is configuration inheritance, which would mean having a local mkdocs.yml and one for 'non-local', with both inheriting from a common one.

Not entirely sure if there perhaps a better one. Perhaps someone else will chime in.

[squidfunk]

The approach we've been following for the last few years is what @alexvoss suggested – use an environment variable and define it as a secret in your CI build. This ensures that analytics are only collected for the live site.

mkdocs-material/mkdocs.yml

Lines 104 to 106 in d363f90

	analytics:
	provider: google
	property: !ENV GOOGLE_ANALYTICS_KEY

For GitHub Actions, set GOOGLE_ANALYTICS_KEY to your property.

[Matthijz98]

That is a good option.
Thanks