OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documented site search tracking setup

Browse Source
This commit is contained in:
squidfunk 2020-04-02 13:23:38 +02:00
parent b9d44e04c1
commit 8e3fda38f1
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/getting-started.md
View File

@ -643,9 +643,9 @@ extra:
### Google Analytics
MkDocs makes it easy to integrate site tracking with Google Analytics. Besides
basic page views, site search is tracked to better understand how people use
your documentation. Google Analytics can be activated with:
MkDocs makes it easy to integrate site tracking with Google Analytics. To enable
tracking, which is disabled by default, you must add your tracking identifier
to `mkdocs.yml`:
``` yaml
google_analytics:
@ -653,10 +653,20 @@ google_analytics:
- auto
```
Besides basic page views, *site search* can also be tracked to better understand
how people use your documentation and what they expect to find. To enable
search tracking:
1. Go to your Google Analytics **admin settings**
2. Select the property for the respective tracking code
3. Go to the **view settings** tab.
4. Scroll down and enable **site search settings**
5. Set the **query parameter** to `q`.
### Disqus
Material for MkDocs is integrated with [Disqus][24], so if you want to add a
comments section to your documentation set the _shortname_ of your Disqus
comments section to your documentation set the *shortname* of your Disqus
project in `mkdocs.yml`:
``` yaml