Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 01:10:58 +01:00
Code Issues Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-04-02 14:42:13 +02:00
parent efbd228472
commit 3adf71550c
2 changed files with 44 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/setup/changing-the-logo-and-icons.md
View File

@ -108,8 +108,31 @@ markdown_extensions:
- overrides/.icons
```
You can now use all :fontawesome-brands-bootstrap: Bootstrap icons.
You can now use all :fontawesome-brands-bootstrap: Bootstrap icons anywhere in
Markdown files, as well as everywhere icons can be used in `mkdocs.yml`.
However, note that the syntaxes are slightly different:
- __Using icons in configuration__: take the path of the `*.svg` icon file
starting at the `.icons` folder and drop the file extension, e.g. for
`.icons/bootstrap/envelope-paper.svg`, use:
``` yaml
theme:
icon:
logo: bootstrap/enveloper-paper
```
- __Using icons in Markdown files__: additionally to taking the path from the
`.icons` folder as noted above, replace all `/` with `-` and enclose the icon
shortcode in two colons:
```
:bootstrap-enveloper-paper:
```
For further notes on icon usage, please consult the [icon reference].
[extend the theme]: ../customization.md#extending-the-theme
[custom_dir]: https://www.mkdocs.org/user-guide/configuration/#custom_dir
[Bootstrap]: https://icons.getbootstrap.com/
[icon reference]: ../reference/icons-emojis.md#using-icons

29
docs/setup/setting-up-site-analytics.md
View File

@ -121,20 +121,31 @@ integrated with the [cookie consent] feature[^1].
=== ":material-google-analytics: Google Analytics 4"
1. Go to your Google Analytics __dashboard__
2. Go to the __Configure__ page on the left hand menu, then select __Custom Definitions__
3. Click the __Custom metrics__ tab and then __Create custom metrics__, enter the following values:
1. Go to your Google Analytics __dashboard__
2. Go to the __configure__ page on the left hand menu, then select
__custom definitions__
3. Click the __custom metrics__ tab and then __create custom metrics__,
enter the following values:
* Metric name: Page helpful
* Description: Was this page helpful?
* Event parameter: data
* Event parameter: `data`
* Unit of measurement: Standard
4. Go to the __Explore__ page on the left hand menu, create a new __blank exploration__
5. Configure the report as follows:
4. Go to the __explore__ page on the left hand menu, create a new
__blank exploration__
5. Configure the report as follows:
* Dimensions: Add `Event name` and `Page location`
* Metrics: Add `Event count` and `Page helpful` (the custom metric created in step 3)
* Metrics: Add `Event count` and `Page helpful`
(the custom metric created in step 3)
* Rows: `Page location`
* Values: `Page helpful`
* Filters: Add a new filter for `Event name / exactly matches / feedback`
* Values: Drag in both `Event count` and `Page helpful`
* Filters: Add a new filter for
`Event name / exactly matches / feedback`
!!! warning "Delay in data availability"