diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 7c6828d79..0cdd15de5 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -144,7 +144,7 @@ write your documentation. The server will automatically rebuild the site upon saving. Start it with: ``` sh -mkdocs serve # (1) +mkdocs serve # (1)! ``` 1. If you have a large documentation project, it might take minutes until diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index 6b2035708..acbe3f95f 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -26,10 +26,10 @@ contents: === "Material for MkDocs" ``` yaml - name: ci # (1) + name: ci # (1)! on: push: - branches: # (2) + branches: # (2)! - master - main jobs: @@ -40,7 +40,7 @@ contents: - uses: actions/setup-python@v2 with: python-version: 3.x - - run: pip install mkdocs-material # (3) + - run: pip install mkdocs-material # (3)! - run: mkdocs gh-deploy --force ``` @@ -80,7 +80,7 @@ contents: - run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - run: mkdocs gh-deploy --force env: - GH_TOKEN: ${{ secrets.GH_TOKEN }} # (1) + GH_TOKEN: ${{ secrets.GH_TOKEN }} # (1)! ``` 1. Remember to set the `GH_TOKEN` environment variable to the value of your diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index 4da65114b..0fd362ab2 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -45,7 +45,7 @@ lines to `mkdocs.yml`: theme: icon: admonition: - : # (1) + : # (1)! ``` 1. Set ` to any of the [supported types] and `` to any valid icon diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index 056180197..595a15dfb 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -56,7 +56,7 @@ and inline comments in the language of the code block. Add the following to ``` yaml theme: features: - - content.code.annotate # (1) + - content.code.annotate # (1)! ``` 1. :man_raising_hand: I'm a code annotation! I can contain `code`, __formatted diff --git a/docs/reference/images.md b/docs/reference/images.md index b890848de..69529b39b 100644 --- a/docs/reference/images.md +++ b/docs/reference/images.md @@ -98,7 +98,7 @@ can be added to images. _Example_: ```html -
+
![Dummy image](https://dummyimage.com/600x400/){ width="300" }
Image caption
diff --git a/docs/reference/mathjax.md b/docs/reference/mathjax.md index cb49200ce..8ccb25b5e 100644 --- a/docs/reference/mathjax.md +++ b/docs/reference/mathjax.md @@ -36,7 +36,7 @@ lines to `mkdocs.yml`: } }; - document$.subscribe(() => { // (1) + document$.subscribe(() => { // (1)! MathJax.typesetPromise() }) ``` diff --git a/docs/reference/meta-tags.md b/docs/reference/meta-tags.md index 654ff3a1e..52fd3ecd5 100644 --- a/docs/reference/meta-tags.md +++ b/docs/reference/meta-tags.md @@ -39,7 +39,7 @@ some custom front matter. Add the following lines at the top of a Markdown file: ``` bash --- -title: Lorem ipsum dolor sit amet # (1) +title: Lorem ipsum dolor sit amet # (1)! --- # Document title diff --git a/docs/setup/adding-a-comment-system.md b/docs/setup/adding-a-comment-system.md index ddc3de5ae..62ba4ecc7 100644 --- a/docs/setup/adding-a-comment-system.md +++ b/docs/setup/adding-a-comment-system.md @@ -39,7 +39,7 @@ in the `overrides` folder: var disqus_config = function() { this.page.url = "{{ page.canonical_url }}" this.page.identifier = - "{{ page.canonical_url | replace(config.site_url, '') }}" // (1) + "{{ page.canonical_url | replace(config.site_url, '') }}" // (1)! } /* Set up for the first time */ @@ -69,7 +69,7 @@ in the `overrides` folder: ``` yaml extra: - disqus: # (1) + disqus: # (1)! ``` 1. Add your Disqus [shortname] here. diff --git a/docs/setup/changing-the-colors.md b/docs/setup/changing-the-colors.md index 0e67be101..e15ad02e1 100644 --- a/docs/setup/changing-the-colors.md +++ b/docs/setup/changing-the-colors.md @@ -176,12 +176,12 @@ palettes: ``` yaml theme: - palette: # (1) + palette: # (1)! - scheme: default toggle: icon: material/toggle-switch-off-outline name: Switch to dark mode - - scheme: slate # (2) + - scheme: slate # (2)! toggle: icon: material/toggle-switch name: Switch to light mode @@ -232,12 +232,12 @@ definition in `mkdocs.yml`: ``` yaml theme: palette: - - media: "(prefers-color-scheme: light)" # (1) + - media: "(prefers-color-scheme: light)" # (1)! scheme: default toggle: icon: material/toggle-switch-off-outline name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" # (2) + - media: "(prefers-color-scheme: dark)" # (2)! scheme: slate toggle: icon: material/toggle-switch @@ -325,7 +325,7 @@ can tune the `slate` theme with: ``` css [data-md-color-scheme="slate"] { - --md-hue: 210; /* (1) */ + --md-hue: 210; /* (1)! */ } ``` diff --git a/docs/setup/changing-the-fonts.md b/docs/setup/changing-the-fonts.md index 510afaa0c..93cf45fb2 100644 --- a/docs/setup/changing-the-fonts.md +++ b/docs/setup/changing-the-fonts.md @@ -100,7 +100,7 @@ globally to be used as the site-wide regular or monospaced font: ``` css :root { - --md-text-font-family: ""; /* (1) */ + --md-text-font-family: ""; /* (1)! */ } ``` diff --git a/docs/setup/changing-the-language.md b/docs/setup/changing-the-language.md index 506c56fff..1668c3a1e 100644 --- a/docs/setup/changing-the-language.md +++ b/docs/setup/changing-the-language.md @@ -101,7 +101,7 @@ can be defined via `mkdocs.yml`. extra: alternate: - name: English - link: /en/ # (1) + link: /en/ # (1)! lang: en - name: Deutsch link: /de/ @@ -189,11 +189,11 @@ adjust the ones you want to override: ``` html {% import "partials/languages/de.html" as language %} - {% import "partials/languages/en.html" as fallback %} + {% import "partials/languages/en.html" as fallback %} {% macro override(key) %}{{ { - "source.file.date.created": "Erstellt am", + "source.file.date.created": "Erstellt am", "source.file.date.updated": "Aktualisiert am" }[key] }}{% endmacro %} diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index f09e791d2..7af1a29f0 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -227,7 +227,7 @@ in `*.svg` file format into the resulting HTML page. Enable it via `mkdocs.yml`: ``` yaml markdown_extensions: - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji # (1) + emoji_index: !!python/name:materialx.emoji.twemoji # (1)! emoji_generator: !!python/name:materialx.emoji.to_svg ``` @@ -310,7 +310,7 @@ The [Highlight] extension adds support for syntax highlighting of code blocks markdown_extensions: - pymdownx.highlight: anchor_linenums: true - - pymdownx.superfences # (1) + - pymdownx.superfences # (1)! ``` 1. [Highlight] is used by the [SuperFences][pymdownx.superfences] extension to diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 4b5758cf7..2b44e7919 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -346,7 +346,7 @@ your custom event listener: keyboard$.subscribe(function(key) { if (key.mode === "global" && key.type === "x") { /* Add custom keyboard handler here */ - key.claim() // (1) + key.claim() // (1)! } }) ``` @@ -379,7 +379,7 @@ of CSS: ``` css .md-grid { - max-width: 1440px; /* (1) */ + max-width: 1440px; /* (1)! */ } ``` diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index 6cd7816ae..a5ad3a246 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -81,7 +81,7 @@ Add the following lines to `mkdocs.yml`: ``` yaml extra: - analytics: # (1) + analytics: # (1)! feedback: title: Was this page helpful? ratings: @@ -93,7 +93,7 @@ extra: - icon: material/emoticon-sad-outline name: This page could be improved data: 0 - note: >- # (2) + note: >- # (2)! Thanks for your feedback! Help us improve this page by using our feedback form. ``` @@ -232,7 +232,7 @@ following to `mkdocs.yml`: extra: consent: title: Cookie consent - description: >- # (1) + description: >- # (1)! 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 @@ -253,7 +253,7 @@ integrated by using the `cookies` field: extra: consent: cookies: - analytics: Custom name # (1) + analytics: Custom name # (1)! ``` 1. The default name of the `analytics` cookie is `Google Analytics`. @@ -264,7 +264,7 @@ integrated by using the `cookies` field: extra: consent: cookies: - analytics: Google Analytics # (1) + analytics: Google Analytics # (1)! custom: Custom cookie ``` @@ -322,12 +322,12 @@ used to configure the custom integration via `mkdocs.yml`: ``` html @@ -345,7 +345,7 @@ used to configure the custom integration via `mkdocs.yml`: extra: analytics: provider: custom - property: foobar # (1) + property: foobar # (1)! ``` 1. You can add arbitrary key-value combinations to configure your diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index 956ec1c44..3ba1e80d4 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -53,7 +53,7 @@ The following configuration options are supported: ``` yaml plugins: - search: - lang: # (1) + lang: # (1)! - en - ru ``` @@ -102,7 +102,7 @@ The following configuration options are supported: ``` yaml plugins: - search: - separator: '[\s\-\.]' # (1) + separator: '[\s\-\.]' # (1)! ``` 1. Tokenization itself is carried out by [lunr's default tokenizer], which @@ -342,7 +342,7 @@ a Markdown file: ``` bash --- search: - boost: 2 # (1) + boost: 2 # (1)! --- # Document title @@ -467,14 +467,14 @@ following transformations, which can be customized by [extending the theme]: ``` ts export function defaultTransform(query: string): string { return query - .split(/"([^"]+)"/g) /* (1) */ + .split(/"([^"]+)"/g) /* (1)! */ .map((terms, index) => index & 1 ? terms.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g, " +") : terms ) .join("") - .replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") /* (2) */ - .trim() /* (3) */ + .replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") /* (2)! */ + .trim() /* (3)! */ } ``` diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index ae0fe6a8d..e85a059d3 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -78,7 +78,7 @@ The following configuration options are available: plugins: - social: cards_color: - fill: "#0FF1CE" # (1) + fill: "#0FF1CE" # (1)! text: "#FFFFFF" ``` diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index ee6c8fb96..8a52ab035 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -74,7 +74,7 @@ you can [override the `outdated` block][overriding blocks]: {% block outdated %} You're not viewing the latest version. - + Click here to go to latest. {% endblock %}