diff --git a/CHANGELOG b/CHANGELOG index 52ecee0b3..e560e339b 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,7 @@ +mkdocs-material-8.0.2+insiders-4.1.0 (2021-11-30) + + * Added support for passing page title to feedback forms + mkdocs-material-8.0.2 (2021-11-30) * Fixed #3275: Code annotations always disappear on click diff --git a/docs/customization.md b/docs/customization.md index 575b4840a..e00f5fbda 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -173,7 +173,7 @@ Then, e.g. to override the site title, add the following lines to `main.html`: The following template blocks are provided by the theme: | Block name | Purpose | -|:------------------|:------------------------------------------------| +| :---------------- | :---------------------------------------------- | | `analytics` | Wraps the Google Analytics integration | | `announce` | Wraps the announcement bar | | `config` | Wraps the JavaScript application config | diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 763dcfa60..986977ca7 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,6 +6,10 @@ template: overrides/main.html ## Material for MkDocs Insiders +### 4.1.0 _ November 30, 2021 { id="4.0.0" } + +- Added support for passing page title to feedback forms + ### 4.0.0 _ November 28, 2021 { id="4.0.0" } - Removed deprecated content tabs legacy implementation diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index b44b4bdb0..a49404f88 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -168,11 +168,14 @@ The following properties must be set for each rating: The value of this property is shown after the user selected the rating. It may contain arbitrary HTML tags, which is especially useful to ask the user to provide more detailed feedback for the current page through a form. - It's also possible to pre-fill forms with the path to the current page by - using the `{}` placeholder, e.g.: + It's also possible to pre-fill forms with the URL and title of the current + page by using the following placeholders: - ``` url - https://github.com///issues/new/?title=[Feedback]+{} + - `{url}` – Page URL + - `{title}` – Page title + + ``` + https://github.com/.../issues/new/?title=[Feedback]+{title}+-+{url} ``` In this example, when clicking the link, the user is redirected to the "new @@ -180,7 +183,7 @@ The following properties must be set for each rating: of the current document, e.g.: ``` - [Feedback] /setup/setting-up-site-analytics/ + [Feedback] Setting up site analytics – /setup/setting-up-site-analytics/ ``` An alternative to GitHub issues is [Google Forms].