Merge pull request #3218 from squidfunk/feature/insiders-ghost-pepper

Material for MkDocs 8

Author: squidfunk

.browserslistrc

@@ -1 +1 @@
-last 4 years
+last 2 years

.editorconfig

@@ -34,11 +34,7 @@ trim_trailing_whitespace = true
 [*.md]
 trim_trailing_whitespace = false
 
-# Makefiles
+# Python
 [*.py]
+indent_style = space
 indent_size = 4
-
-# Makefiles
-[Makefile]
-indent_style = tab
-indent_size = 8

.gitignore

@@ -43,6 +43,7 @@
 *.tsbuildinfo
 .cache
 .eslintcache
+__pycache__
 
 # -----------------------------------------------------------------------------
 # General

.stylelintrc

@@ -62,6 +62,12 @@
     "font-family-name-quotes": "always-where-recommended",
     "font-weight-notation": "numeric",
     "hue-degree-notation": "number",
+    "length-zero-no-unit": [
+      true,
+      {
+        "ignore": ["custom-properties"]
+      }
+    ],
     "linebreaks": "unix",
     "media-feature-name-no-unknown": null,
     "no-descending-specificity": null,
@@ -80,6 +86,7 @@
     "selector-class-pattern": null,
     "selector-combinator-space-before": null,
     "selector-descendant-combinator-no-non-space": null,
+    "selector-id-pattern": null,
     "selector-max-empty-lines": 0,
     "selector-max-id": 0,
     "selector-no-qualifying-type": null,
@@ -89,6 +96,7 @@
     "unicode-bom": "never",
     "unit-allowed-list": [
       "%",
+      "ch",
       "dppx",
       "deg",
       "em",
@@ -141,6 +149,8 @@
     "scss/double-slash-comment-whitespace-inside": "always",
     "scss/at-extend-no-missing-placeholder": null,
     "scss/no-duplicate-mixins": true,
+    "scss/no-global-function-names": null,
+    "scss/operator-no-newline-after": null,
     "scss/operator-no-unspaced": true,
     "scss/partial-no-import": true,
     "scss/percent-placeholder-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",

docs/customization.md

@@ -101,17 +101,18 @@ assets may also be put in the `overrides` directory:
 ├─ partials/
 │  ├─ integrations/                    # Third-party integrations
 │  │  ├─ analytics/                    # Analytics integrations
-│  │  ├─ analytics.html                # Analytics setup
-│  │  └─ disqus.html                   # Disqus
+│  │  └─ analytics.html                # Analytics setup
 │  ├─ languages/                       # Translation languages
+│  ├─ content.html                     # Page content
+│  ├─ copyright.html                   # Copyright and theme information
 │  ├─ footer.html                      # Footer bar
 │  ├─ header.html                      # Header bar
 │  ├─ language.html                    # Translation setup
 │  ├─ logo.html                        # Logo in header and sidebar
 │  ├─ nav.html                         # Main navigation
 │  ├─ nav-item.html                    # Main navigation item
 │  ├─ palette.html                     # Color palette
-│  ├─ search.html                      # Search box
+│  ├─ search.html                      # Search interface
 │  ├─ social.html                      # Social links
 │  ├─ source.html                      # Repository information
 │  ├─ source-file.html                 # Source file information
@@ -192,28 +193,6 @@ The following template blocks are provided by the theme:
 | `styles`          | Wraps the style sheets (also extra sources)     |
 | `tabs`            | Wraps the tabs navigation (if available)        |
 
-#### Additional variables
-
-Besides template blocks, Material for MkDocs provides extra variables for parts
-that cannot be overridden with template blocks (due to technical limitations of
-the template engine). If you want to add further information after the _Made
-with Material for MkDocs_ hint in the footer, add the following line to
-`main.html`:
-
-``` html
-{% extends "base.html" %}
-
-{% set extracopyright %}
-  <!-- Add additional copyright information here -->
-{% endset %}
-```
-
-The following template variables are provided by the theme:
-
-| Block name        | Purpose                                         |
-|:------------------|:------------------------------------------------|
-| `extracopyright`  | Adds custom copyright information               |
-
 ## Theme development
 
 Material for MkDocs is built on top of [TypeScript], [RxJS] and [SASS], and

docs/getting-started.md

@@ -16,7 +16,7 @@ If not, we recommended using [`docker`][docker].
 
 ## Installation
 
-!!! danger "8.0.0 Beta 1 is out!"
+!!! danger "8.0.0 Beta 2 is out!"
 
     Help test the latest version of Material for MkDocs, introducing many new
     features and improvements like [code annotations], [anchor tracking] and

docs/insiders/index.md

@@ -17,7 +17,7 @@ that new features are first exclusively released to sponsors as part of
   </div>
   <figcaption markdown>
 
-The official documentation is built with Insiders
+This documentation is built with Insiders
 [squidfunk.github.io/mkdocs-material][Material for MkDocs]
 
   </figcaption>

docs/publishing-your-site.md

@@ -91,9 +91,9 @@ Now, when a new commit is pushed to either the `master` or `main` branches,
 the static site is automatically built and deployed. Push your changes to see
 the workflow in action.
 
-If the GitHub Page doesn't show up after a few minutes, ensure the source branch
-for your GitHub Page is set to `gh-pages` in your repository settings 
-`github.com/<username>/<repository>/settings/pages`.
+If the GitHub Page doesn't show up after a few minutes, go to your
+settings of your repository and ensure that the [publishing source branch]
+for your GitHub Page is set to `gh-pages`.
 
 Your documentation should shortly appear at `<username>.github.io/<repository>`.
 
@@ -102,6 +102,7 @@ Your documentation should shortly appear at `<username>.github.io/<repository>`.
   [personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
   [Insiders]: insiders/index.md
   [GitHub secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
+  [publishing source branch]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
 
 ### with MkDocs
 

docs/reference/admonitions.md

@@ -287,7 +287,7 @@ only the `inline` modifier.
 
     Use `inline` to align to the left (right for rtl languages).
 
-__Important__: Admonitions that use the `inline` modifiers _must_ be declared
+__Important__: admonitions that use the `inline` modifiers _must_ be declared
 prior to the content block you want to place them beside. If there's
 insufficient space to render the admonition next to the block, the admonition
 will stretch to the full width of the viewport, e.g. on mobile viewports.
@@ -299,7 +299,7 @@ will stretch to the full width of the viewport, e.g. on mobile viewports.
 Following is a list of type qualifiers provided by Material for MkDocs, whereas
 the default type, and thus fallback for unknown type qualifiers, is `note`:
 
-`note`{ #type-note }, ~~`seealso`~~ [^1]
+`note`{ #type-note }
 
 :   !!! note
 
@@ -395,13 +395,6 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
         euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
         purus auctor massa, nec semper lorem quam in massa.
 
-  [^1]:
-    The `seealso` qualifier was originally adapted from the `readthedocs` theme,
-    in order to make it easier for authors to migrate to Material for MkDocs.
-    However, when the title is omitted, the admonition extension will render it
-    as `Seealso`, which is incorrect English. For this reason, it was deprecated
-    in :octicons-tag-24: 7.1.5 and will be removed in :octicons-tag-24: 8.0.0.
-
 ## Customization
 
 ### Custom admonitions

docs/reference/code-blocks.md

@@ -90,14 +90,14 @@ shortcode for a given language.
 _Example_:
 
 ```` markdown
-``` python
+``` py
 import tensorflow as tf
 ```
 ````
 
 _Result_:
 
-``` python
+``` py
 import tensorflow as tf
 ```
 
@@ -183,7 +183,7 @@ allows to split large code blocks for readability.
 _Example_:
 
 ```` markdown
-``` python linenums="1"
+``` py linenums="1"
 def bubble_sort(items):
     for i in range(len(items)):
         for j in range(len(items) - 1 - i):
@@ -194,7 +194,7 @@ def bubble_sort(items):
 
 _Result_:
 
-``` python linenums="1"
+``` py linenums="1"
 def bubble_sort(items):
     for i in range(len(items)):
         for j in range(len(items) - 1 - i):
@@ -214,7 +214,7 @@ at `1`, regardless of the starting line number specified as part of
     _Example_:
 
     ```` markdown 
-    ``` python hl_lines="2 3"
+    ``` py hl_lines="2 3"
     def bubble_sort(items):
         for i in range(len(items)):
             for j in range(len(items) - 1 - i):
@@ -225,7 +225,7 @@ at `1`, regardless of the starting line number specified as part of
 
     _Result_:
 
-    ``` python linenums="1" hl_lines="2 3"
+    ``` py linenums="1" hl_lines="2 3"
     def bubble_sort(items):
         for i in range(len(items)):
             for j in range(len(items) - 1 - i):
@@ -238,7 +238,7 @@ at `1`, regardless of the starting line number specified as part of
     _Example_:
 
     ```` markdown
-    ``` python hl_lines="2-5"
+    ``` py hl_lines="2-5"
     def bubble_sort(items):
         for i in range(len(items)):
             for j in range(len(items) - 1 - i):
@@ -249,7 +249,7 @@ at `1`, regardless of the starting line number specified as part of
 
     _Result_:
 
-    ``` python linenums="1" hl_lines="2-5"
+    ``` py linenums="1" hl_lines="2-5"
     def bubble_sort(items):
         for i in range(len(items)):
             for j in range(len(items) - 1 - i):

docs/reference/meta-tags.md

@@ -72,32 +72,6 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor.
 This will set the `meta` tag containing the site description inside the
 document `head` for the current page to the provided value.
 
-<div class="mdx-deprecated" markdown>
-
-### Adding a web app manifest
-
-[:octicons-tag-24: 3.1.0][manifest support] ·
-:octicons-archive-24: Deprecated ·
-:octicons-trash-24: 8.0.0
-
-A [web app manifest] is a simple JSON file that specifies how your web
-application should behave when installed on the user's mobile device or desktop,
-which can be set via `mkdocs.yml`:
-
-``` yaml
-extra:
-  manifest: manifest.webmanifest # (1)
-```
-
-1.  This option was deprecated, as it's not widely used and the same behavior
-    can be achieved with [theme extension].
-
-  [web app manifest]: https://web.dev/add-manifest/
-  [manifest support]: https://github.com/squidfunk/mkdocs-material/releases/tag/3.1.0
-  [theme extension]: ../customization.md#extending-the-theme
-
-</div>
-
 ## Customization
 
 ### Using metadata in templates
@@ -116,6 +90,7 @@ e.g. to add indexing policies for search engines via the `robots` property:
 {% endblock %}
 ```
 
+  [theme extension]: ../customization.md#extending-the-theme
   [overriding blocks]: ../customization.md#overriding-blocks
 
 #### on a single page