1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-23 23:21:00 +01:00

Added documentation on GDPR compliance

This commit is contained in:
squidfunk 2018-06-10 18:06:45 +02:00
parent c1f8a68096
commit 55aa14014b
4 changed files with 57 additions and 5 deletions

View File

@ -1,10 +1,11 @@
mkdocs-material-2.8.0 (2018-06-xx)
* Added support for grouping code blocks with tabs
* Added Slovak translations
* Added Material icons webfont to distribution files (GDPR)
* Added FontAwesome webfont to distribution files (GDPR)
* Added note on compliance with GDPR
* Fixed #790: Prefixed internal identifiers with "__" to avoid name clashes
* Updated Promise polyfill
mkdocs-material-2.7.3 (2018-04-26)

47
docs/compliance.md Normal file
View File

@ -0,0 +1,47 @@
# Compliance with GDPR
## Material does not process any personal data
Material is a theme for MkDocs, a static site generator. In itself, Material
does not perform any tracking or processing of personal data. However, some of
the third-party services that Material integrates with may actually be in breach
with the [General Data Protection Regulation][1] (GDPR) and need to be evaluated
carefully.
[1]: https://en.wikipedia.org/wiki/General_Data_Protection_Regulation
## Third-party services
### Google Fonts
Material makes fonts [easily configurable][2] by relying on Google Fonts CDN.
However, embedding fonts from Google is currently within a gray area as there's
no official statement or ruling regarding GDPR compliance and the topic is still
[actively discussed][3]. For this reason, if you need to ensure GDPR compiance,
you should disable the usage of the Google Font CDN with:
``` yaml
theme:
font: false
```
When Google Fonts are disabled, Material will default to **Helvetica Neue** and
**Monaco** with their corresponding fall backs, relying on system fonts. You
could however include your own, self-hosted webfont by [overriding][4] the
`fonts` block.
The icon fonts (Material and FontAwesome) are bundled with the theme, and thus
self-hosted so there's no third-party involved.
[2]: getting-started.md#font-family
[3]: https://github.com/google/fonts/issues/1495
[4]: customization.md/#overriding-template-blocks
### Google Analytics and Disqus
Material comes with [Google Analytics][4] and [Disqus][5] integrations that need
to be *enabled explicitly*. Disable both integrations in order to be in
compliance with the GDPR.
[5]: getting-started.md#google-analytics
[6]: getting-started.md#disqus

View File

@ -237,12 +237,15 @@ symbols ((c), (tm), (r)) and fractions (1/2, 1/4, ...).
lists and other block elements, which the [Fenced Code Blocks][23] extension
from the standard Markdown library doesn't parse correctly.
SuperFences does also allow [grouping code blocks with tabs][24]
[22]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
[23]: https://python-markdown.github.io/extensions/fenced_code_blocks/
[24]: codehilite.md#grouping-code-blocks
### Tasklist
[Tasklist][24] adds support for styled checkbox lists. This is useful for
[Tasklist][25] adds support for styled checkbox lists. This is useful for
keeping track of tasks and showing what has been done and has yet to be done.
Checkbox lists are like regular lists, but prefixed with `[ ]` for empty or
`[x]` for filled checkboxes.
@ -275,12 +278,12 @@ Result:
* [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
* [ ] Nulla vel eros venenatis, imperdiet enim id, faucibus nisi
[24]: https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
[25]: https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
### Tilde
[Tilde][25] provides an easy way to ~~strike through~~ cross out text.
[Tilde][26] provides an easy way to ~~strike through~~ cross out text.
The portion of text that should be erased must be enclosed in two tildes
`~~...~~` and the extension will take care of the rest.
[25]: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
[26]: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/

View File

@ -112,6 +112,7 @@ pages:
- PyMdown: extensions/pymdown.md
- Specimen: specimen.md
- Customization: customization.md
- Compliance with GDPR: compliance.md
- Release notes: release-notes.md
- Author's notes: authors-notes.md
- Contributing: contributing.md