From e30b814c57dcf027869076a87a2a605803d70ed5 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 18 Jul 2021 17:57:45 +0200 Subject: [PATCH] Updated code block annotation usage --- docs/publishing-your-site.md | 2 +- docs/reference/code-blocks.md | 13 ++++++++++--- docs/setup/setting-up-site-analytics.md | 8 +++++++- docs/setup/setting-up-site-search.md | 2 +- docs/setup/setting-up-versioning.md | 2 +- mkdocs.yml | 1 + 6 files changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index aa054ce36..64d3b281e 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -25,7 +25,7 @@ contents: === "Material for MkDocs" - ``` { .yaml .annotate } + ``` yaml name: ci # (1) on: push: diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index d7bb5c0e1..16d0dbbbc 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -223,7 +223,14 @@ to the corresponding tooltip. In order to opt-in to annotation support, a slightly different syntax is required – just add the respective [language short code][17] and the `.annotate` -class, after the three backticks. +class, after the three backticks. Alternatively, if you want to enable annotations +globally, add the following to `mkdocs.yml`: + +``` yaml +theme: + features: + - content.code.annotate +``` Note that annotations can be __placed anywhere__ in a code block where a comment for the language can be placed, which for JavaScript is `// (1)` and @@ -232,7 +239,7 @@ for the language can be placed, which for JavaScript is `// (1)` and _Example_: ```` markdown -``` { .js .annotate } +``` js document$.subscribe(function() { // (1) var tables = document.querySelectorAll(/* (2) */ "article table") tables.forEach(function(table) { @@ -247,7 +254,7 @@ document$.subscribe(function() { // (1) _Result_: -``` { .js .annotate } +``` js document$.subscribe(function() { // (1) var tables = document.querySelectorAll(/* (2) */ "article table") tables.forEach(function(table) { diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index e6d99788a..d12feb81e 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -72,7 +72,13 @@ Add the following to `mkdocs.yml`: ``` yaml extra: - consent: true + consent: + title: Cookie consent + description: > + We use cookies to recognize your repeated visits and preferences, as well + as to measure the effectiveness of our documentation and whether users + find what they're searching for. With your consent, you're helping us to + make our documentation better. ``` When a user first visits your site, a cookie consent form is rendered: diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index 3ad9772af..63ba8f764 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -276,7 +276,7 @@ When a user enters a query into the search box, the query is pre-processed before it is submitted to the search index. Material for MkDocs will apply the following transformations, which can be customized by [extending the theme][20]: -``` { .ts .annotate } +``` ts export function defaultTransform(query: string): string { return query .split(/"([^"]+)"/g) /* (1) */ diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index 404881960..4bd74ed6f 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -75,7 +75,7 @@ If you're using versioning, you might want to display a warning when the user visits any other version than the latest version. Using [theme extension][8], you can [define the `outdated` block][9]: -``` { .html .annotate } +``` html {% block outdated %} You're not viewing the latest version. diff --git a/mkdocs.yml b/mkdocs.yml index 1c3a32bdc..ab51afac9 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,7 @@ theme: # Default values, taken from mkdocs_theme.yml language: en features: + - content.code.annotate - content.tabs.link # - navigation.instant - navigation.sections