[pull] master from squidfunk:master

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+	"name": "Material for MkDocs - VS Code dev container",
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",
+	"features": {
+		"ghcr.io/devcontainers/features/python:1": {
+			"installTools": true,
+			"version": "3.11"
+	  }
+	},
+	"postCreateCommand": "pip install -e . && pip install mkdocs-minify-plugin mkdocs-redirects && npm install && npm run build"
+}

.dockerignore

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2023 Martin Donath <[email protected]>
+# Copyright (c) 2016-2025 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
@@ -22,6 +22,6 @@
 .git
 .github
 docs
-material/.overrides
+material/overrides
 node_modules
 src

.editorconfig

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2023 Martin Donath <[email protected]>
+# Copyright (c) 2016-2025 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
@@ -30,10 +30,6 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-# Markdown
-[*.md]
-trim_trailing_whitespace = false
-
 # Python
 [*.py]
 indent_style = space

.eslintignore

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2023 Martin Donath <[email protected]>
+# Copyright (c) 2016-2025 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

.eslintrc

@@ -6,6 +6,7 @@
   },
   "plugins": [
     "@typescript-eslint",
+    "@stylistic/ts",
     "eslint-plugin-eslint-comments",
     "eslint-plugin-import",
     "eslint-plugin-jsdoc",
@@ -166,7 +167,41 @@
     "@typescript-eslint/consistent-type-assertions": "error",
     "@typescript-eslint/dot-notation": "error",
     "@typescript-eslint/explicit-member-accessibility": "error",
-    "@typescript-eslint/indent": [
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": "enumMember",
+        "format": [
+          "UPPER_CASE"
+        ]
+      }
+    ],
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-empty-object-type": "off",
+    "@typescript-eslint/no-extraneous-class": "error",
+    "@typescript-eslint/no-misused-promises": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-parameter-properties": "off",
+    "@typescript-eslint/no-floating-promises": "error",
+    "@typescript-eslint/no-shadow": [
+      "error",
+      {
+        "hoist": "never"
+      }
+    ],
+    "@typescript-eslint/no-unnecessary-type-assertion": "error",
+    "@typescript-eslint/no-unused-expressions": "error",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/only-throw-error": "error",
+    "@typescript-eslint/prefer-for-of": "off",
+    "@typescript-eslint/prefer-function-type": "error",
+    "@typescript-eslint/triple-slash-reference": "off",
+    "@typescript-eslint/unbound-method": "error",
+    "@typescript-eslint/unified-signatures": "error",
+
+    /* Plugin: @stylistic/ts */
+    "@stylistic/ts/indent": [
       "warn",
       2,
       {
@@ -191,7 +226,7 @@
         "offsetTernaryExpressions": true
       }
     ],
-    "@typescript-eslint/member-delimiter-style": [
+    "@stylistic/ts/member-delimiter-style": [
       "error",
       {
         "multiline": {
@@ -203,42 +238,12 @@
         }
       }
     ],
-    "@typescript-eslint/naming-convention": [
-      "error",
-      {
-        "selector": "enumMember",
-        "format": [
-          "UPPER_CASE"
-        ]
-      }
-    ],
-    "@typescript-eslint/no-empty-interface": "off",
-    "@typescript-eslint/no-extraneous-class": "error",
-    "@typescript-eslint/no-misused-promises": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-parameter-properties": "off",
-    "@typescript-eslint/no-floating-promises": "error",
-    "@typescript-eslint/no-shadow": [
-      "error",
-      {
-        "hoist": "never"
-      }
-    ],
-    "@typescript-eslint/no-throw-literal": "error",
-    "@typescript-eslint/no-unnecessary-type-assertion": "error",
-    "@typescript-eslint/no-unused-expressions": "error",
-    "@typescript-eslint/no-unused-vars": "off",
-    "@typescript-eslint/no-var-requires": "off",
-    "@typescript-eslint/prefer-for-of": "off",
-    "@typescript-eslint/prefer-function-type": "error",
-    "@typescript-eslint/semi": [
+    "@stylistic/ts/semi": [
       "error",
       "never"
     ],
-    "@typescript-eslint/triple-slash-reference": "off",
-    "@typescript-eslint/type-annotation-spacing": "error",
-    "@typescript-eslint/unbound-method": "error",
-    "@typescript-eslint/unified-signatures": "error",
+    "@stylistic/ts/type-annotation-spacing": "error",
+
     /* Plugin: eslint-plugin-eslint-comments */
     "eslint-comments/no-unused-disable": "error",
     "eslint-comments/no-unused-enable": "error",
@@ -320,7 +325,6 @@
       }
     ],
     "jsdoc/empty-tags": "warn",
-    "jsdoc/newline-after-description": "warn",
     "jsdoc/no-bad-blocks": "warn",
     "jsdoc/no-defaults": "warn",
     "jsdoc/no-types": "warn",

.github/FUNDING.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2023 Martin Donath <[email protected]>
+# Copyright (c) 2016-2025 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/ISSUE_TEMPLATE/01-report-a-bug.yml

@@ -10,7 +10,8 @@ body:
         This field is optional. You may provide additional context for the bug
         you want to report, helping us to understand what you are working on and
         what you are trying to achieve. If the context is not relevant, you can
-        leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
+        leave this field empty.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
 
   - type: textarea
     id: description
@@ -20,7 +21,8 @@ body:
         Please give a detailed description of the bug. Explain where Material
         for MkDocs does not behave as you would expect it to. Be as specific as
         possible. If you have found a workaround or a fix for the problem,
-        please let us maintainers (and all other users) know. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#description)
+        please let us maintainers (and all other users) know.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
     validations:
       required: true
 
@@ -30,8 +32,8 @@ body:
       label: Related links
       description: >-
         Please list all links to the sections of
-        [our documentation](https://squidfunk.github.io/mkdocs-material) that
-        are relevant to the bug, in order to show that you have consulted and
+        [our documentation](https://squidfunk.github.io/mkdocs-material/) that
+        are relevant to the bug in order to show that you have consulted and
         thoroughly read it. Additionally, list links to possibly related open
         and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
         and [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
@@ -50,11 +52,12 @@ body:
       description: >-
         Please create a __.zip file__ with a __minimal reproduction__ for the
         bug. First, read our [reproduction guide](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/)
-        that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
+        that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/) (mandatory) to create a self-contained
         .zip file with the reproduction. We reserve the right to close issues
-        without .zip files. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
+        without .zip files.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
       placeholder: |-
-        Drag and drop .zip file with minimal reproduction here.
+        Drag and drop the .zip file with the minimal reproduction here.
     validations:
       required: true
 
@@ -66,7 +69,8 @@ body:
         Please provide a detailed list of instructions, guiding us maintainers
         through the required steps, helping us to recreate the problem using the
         minimal reproduction you provided. Be as specific as possible and as
-        verbose as necessary – try not to leave anything out. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
+        verbose as necessary – try not to leave anything out.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
       placeholder: |-
         1. ...
         2. ...
@@ -79,10 +83,11 @@ body:
     attributes:
       label: Browser
       description: >-
-        If the bug only happens in __specific browsers__, please select them
-        from the dropdown below. If your browser is not listed or the version
-        is relevant, you may select _Other_ and provide more details in the
-        field above. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
+        This field is optional. If the bug only happens in __specific browsers__,
+        please select them from the dropdown below. If your browser is not
+        listed or the version is relevant, you may select _Other_ and provide
+        more details in the field above.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
       multiple: true
       options:
         - Chrome
@@ -106,7 +111,7 @@ body:
             I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/).
           required: true
         - label: >-
-            I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material),
+            I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material/),
             and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
             and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
           required: true
@@ -115,5 +120,5 @@ body:
             before submitting this bug report.
           required: true
         - label: >-
-            I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/).
+            I have attached a __.zip file__ with a [minimal reproduction](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/) using the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/).
           required: true

.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml

@@ -1,4 +1,4 @@
-name: Report a docs issue
+name: Report a documentation issue
 description: Missing information in our docs? Report a documentation issue
 labels:
   - documentation
@@ -10,9 +10,9 @@ body:
       label: Description
       description: >-
         Please describe the inconsistency or issue you have found in
-        [our documentation](https://squidfunk.github.io/mkdocs-material)
+        [our documentation](https://squidfunk.github.io/mkdocs-material/)
         or indicate where you feel there is a need for improvement. Furthermore,
-        explain the severity of the issue, i.e., it's impact on you and potentially
+        explain the severity of the issue, i.e., its impact on you and potentially
         other users.
         [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#description)
     validations:
@@ -23,7 +23,7 @@ body:
     attributes:
       label: Related links
       description: >-
-        Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material)
+        Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material/)
         that are impacted by the issue you described above. If applicable,
         add screenshots. Additionally, list links to possibly related open
         and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
@@ -58,8 +58,8 @@ body:
         valuable time.
       options:
         - label: >-
-            I have read and followed the [documentation issue reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
+            I have read and followed the [documentation issue guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
           required: true
         - label: >-
-            I have attached the links to the described sections of [the documentation](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
+            I have attached the links to the affected sections of [the documentation](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
           required: true

.github/ISSUE_TEMPLATE/03-request-a-change.yml

@@ -10,15 +10,16 @@ body:
         This field is optional. You may provide additional context for the idea
         you want to propose, helping us to understand what you are working on
         and what you are trying to achieve. If the context is not relevant, you
-        can leave this field empty. [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#context)
+        can leave this field empty.
+        [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#context)
 
   - type: textarea
     id: description
     attributes:
       label: Description
       description: >-
-        Please provide a detailed description of your idea in 2-3 sentences, so
-        that we maintainers can fully understand what change, feature, or
+        Please provide a detailed description of your idea in 2-3 sentences so
+        that we maintainers can fully understand what change, feature, or the
         improvement you are proposing. Don't yet explain the benefits of your
         idea, we'll come to that. Focus on functionality.
         [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#description)
@@ -31,11 +32,10 @@ body:
       label: Related links
       description: >-
         Please list all links to open and closed [issues](https://github.com/squidfunk/mkdocs-material/issues),
-        [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
-        or to [documentation sections](https://squidfunk.github.io/mkdocs-material)
-        that are relevant to your idea.
-        If you discussed your idea with the community on our
-        [discussion board](https://github.com/squidfunk/mkdocs-material/discussions)
+        [discussions](https://github.com/squidfunk/mkdocs-material/discussions),
+        or to [documentation sections](https://squidfunk.github.io/mkdocs-material/)
+        that are relevant to your idea. If you discussed your idea with the
+        community on our [discussion board](https://github.com/squidfunk/mkdocs-material/discussions)
         prior to creating this change request, please link the discussion here as well.
         [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#related-links)
       value: |-
@@ -50,8 +50,8 @@ body:
       label: Use Cases
       description: >-
         Please explain how your idea will work from an author's and user's
-        perspective. Elaborate how the change would positively impact not only
-        you, but the community, and how it aligns with the goals and [philopsophy](https://squidfunk.github.io/mkdocs-material/philosophy/)
+        perspective. Elaborate on how the change would positively impact not only
+        you but our community and how it aligns with the goals and [philosophy](https://squidfunk.github.io/mkdocs-material/philosophy/)
         of the project.
         [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#use-cases)
     validations:
@@ -87,9 +87,9 @@ body:
             I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature).
         required: true
       - label: >-
-            I have ensured that, to the best knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
+            I have ensured that, to the best of my knowledge, [my idea will benefit the entire community](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#benefit-for-the-community).
         required: true
       - label: >-
-            I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues)
+            I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material/), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
             and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
         required: true