Merge in changes from upstream mkdocs-material repository

.editorconfig

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2021 Martin Donath <[email protected]>
+# Copyright (c) 2016-2022 Martin Donath <[email protected]>
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
@@ -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

.eslintignore

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2021 Martin Donath <[email protected]>
+# Copyright (c) 2016-2022 Martin Donath <[email protected]>
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to

.github/workflows/build.yml

@@ -31,9 +31,7 @@ jobs:
         path: "**/node_modules"
         key: ${{ runner.os }}-${{ matrix.node-version }}-node_modules-${{ hashFiles('**/package-lock.json') }}
     - run: npm install
-    - run: npm run tsc
-    - run: npm run lint:ts
-    - run: npm run lint:scss
+    - run: npm run check
     - name: Install Python packaging & linting tools
       run: python -m pip install wheel pylint black -r requirements.txt
     - run: pylint sphinx_immaterial/*.py

.stylelintignore

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2021 Martin Donath <[email protected]>
+# Copyright (c) 2016-2022 Martin Donath <[email protected]>
 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
@@ -23,8 +23,6 @@ docs
 material
 src/**/*.html
 
-# Don't lint shame
-src/assets/stylesheets/_shame.scss
-
 # Prevent stylelint from constantly complaining
+*.css
 *.ts

.stylelintrc

@@ -1,13 +1,14 @@
 {
   "extends": [
+    "stylelint-config-rational-order",
     "stylelint-config-recommended",
-    "stylelint-config-standard",
-    "stylelint-config-rational-order"
+    "stylelint-config-standard-scss"
   ],
   "plugins": [
     "stylelint-scss"
   ],
   "rules": {
+    "alpha-value-notation": "number",
     "at-rule-empty-line-before": [
       "always",
       {
@@ -40,6 +41,7 @@
         ]
       }
     ],
+    "color-function-notation": null,
     "color-hex-length": "long",
     "color-named": "never",
     "comment-empty-line-before": [
@@ -51,13 +53,23 @@
       }
     ],
     "custom-property-empty-line-before": null,
+    "custom-property-pattern": null,
     "declaration-colon-space-after": null,
     "declaration-no-important": true,
     "declaration-block-single-line-max-declarations": 0,
+    "function-calc-no-unspaced-operator": null,
+    "function-no-unknown": null,
     "function-url-no-scheme-relative": true,
     "function-url-quotes": "always",
     "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,
@@ -73,8 +85,10 @@
         ]
       }
     ],
+    "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,
@@ -84,6 +98,7 @@
     "unicode-bom": "never",
     "unit-allowed-list": [
       "%",
+      "ch",
       "dppx",
       "deg",
       "em",
@@ -94,7 +109,23 @@
       "vw",
       "rem"
     ],
+    "value-keyword-case": [
+      "lower",
+      {
+        "ignoreProperties": [
+          "/^--/"
+        ]
+      }
+    ],
     "value-list-comma-newline-after": null,
+    "value-no-vendor-prefix": [
+      true,
+      {
+        "ignoreValues": [
+          "box"
+        ]
+      }
+    ],
     "scss/at-each-key-value-single-line": true,
     "scss/at-else-closing-brace-newline-after": "always-last-in-chain",
     "scss/at-function-parentheses-space-before": "never",
@@ -107,23 +138,22 @@
     "scss/at-mixin-parentheses-space-before": "never",
     "scss/at-mixin-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
     "scss/at-rule-conditional-no-parentheses": true,
+    "scss/comment-no-empty": null,
     "scss/comment-no-loud": true,
     "scss/declaration-nested-properties": "never",
     "scss/dimension-no-non-numeric-values": true,
     "scss/dollar-variable-colon-newline-after": "always-multi-line",
     "scss/dollar-variable-colon-space-after": "always-single-line",
     "scss/dollar-variable-colon-space-before": "never",
-    "scss/dollar-variable-first-in-block": [
-      true,
-      {
-        "ignore": ["comments"],
-        "except": ["function"]
-      }
-    ],
+    "scss/dollar-variable-first-in-block": null,
     "scss/dollar-variable-no-missing-interpolation": true,
     "scss/dollar-variable-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
+    "scss/double-slash-comment-empty-line-before": null,
     "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]+)*$",

MKDOCS_MATERIAL_MERGE_BASE

@@ -1 +1 @@
-ccbf5a693cae34065d2997a1af37992a148adddf
+4f641cc0ee7befd440956e53b8798899482f6ed4

docs/conf.py

@@ -101,6 +101,9 @@
         # "navigation.instant",
         # "header.autohide",
         "navigation.top",
+        "navigation.tracking",
+        "search.highlight",
+        "search.share",
     ],
     "palette": [
         {
@@ -140,8 +143,8 @@
 }  # end html_theme_options
 
 html_last_updated_fmt = ""
-html_use_index = True
-html_domain_indices = True
+html_use_index = False
+html_domain_indices = False
 
 # ---- Other documentation options -------------------------
 

docs/customization.rst

@@ -188,15 +188,18 @@ Configuration Options
         Some features that have been ported from the mkdocs-material theme and can be enabled by specifying the features name in a list
         of strings. The following features are supported:
 
+        - `content.code.annotate <https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations>`_
+        - `header.autohide <https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#automatic-hiding>`_
         - `navigation.expand <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion>`_
-        - `navigation.tabs <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs>`_ (only shows for browsers with large viewports)
-        - `toc.integrate <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration>`_
-        - `navigation.sections <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections>`_
         - `navigation.instant <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading>`_
-        - `header.autohide <https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#automatic-hiding>`_
+        - `navigation.sections <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections>`_
+        - `navigation.tabs <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs>`_ (only shows for browsers with large viewports)
+        - `navigation.tabs.sticky <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#sticky-navigation-tabs>`_
         - `navigation.top <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button>`_
+        - `navigation.tracking <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking>`_
         - `search.highlight <https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting>`_
         - `search.share <https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing>`_
+        - `toc.integrate <https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration>`_
 
     .. confval:: palette
 
@@ -320,6 +323,20 @@ Configuration Options
             Setting this option to `False` may lead to large generated page sizes since the entire
             table of contents tree will be duplicated on every page.
 
+    .. confval:: toc_title
+
+        A string that specifies the title text that appears above the table of
+        contents in the side bar.  If neither this configuration option nor
+        :confval:`toc_title_is_page_title` is specified, a default
+        language-dependent translation of "Table of Contents" is used.  This
+        configuration option takes precedence over
+        :confval:`toc_title_is_page_title`.
+
+    .. confval:: toc_title_is_page_title
+
+       If set to ``True`` and :confval:`toc_title` is unspecified, the table of
+       contents is labeled in the side bar by the title of the page itself.
+
     .. confval:: version_dropdown
 
         A `bool` flag indicating whether the version drop-down selector should be used. See
@@ -431,9 +448,9 @@ aliases. Other required fields include ``version`` and ``title``.
       /1.0
       /2.0
       /3.0-rc1
-  
+
   You can give this pre-released version an alias called "beta" or "latest".
-  
+
   .. code-block:: json
 
       [
@@ -449,7 +466,7 @@ aliases. Other required fields include ``version`` and ``title``.
     :start-at: "version_dropdown": True
     :end-before: }  # end html_theme_options
 
-.. note:: 
+.. note::
     ``aliases`` do not apply when using an external URL (as in not relative to the same webserver)
     in the ``verion`` field.