Skip to content

Commit b83baa6

Browse files
simpleearnsimpleearn
authored
Merge branch 'squidfunk:master' into master
2 parents 8e236f2 + 8fc61b5 commit b83baa6

File tree

14,460 files changed

+42382
-27080
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

14,460 files changed

+42382
-27080
lines changed

‎.dockerignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
1+
# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
22

33
# Permission is hereby granted, free of charge, to any person obtaining a copy
44
# of this software and associated documentation files (the "Software"), to

‎.editorconfig‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
1+
# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
22

33
# Permission is hereby granted, free of charge, to any person obtaining a copy
44
# of this software and associated documentation files (the "Software"), to

‎.eslintignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
1+
# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
22

33
# Permission is hereby granted, free of charge, to any person obtaining a copy
44
# of this software and associated documentation files (the "Software"), to

‎.eslintrc‎

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
},
77
"plugins": [
88
"@typescript-eslint",
9+
"@stylistic/ts",
910
"eslint-plugin-eslint-comments",
1011
"eslint-plugin-import",
1112
"eslint-plugin-jsdoc",
@@ -166,7 +167,41 @@
166167
"@typescript-eslint/consistent-type-assertions": "error",
167168
"@typescript-eslint/dot-notation": "error",
168169
"@typescript-eslint/explicit-member-accessibility": "error",
169-
"@typescript-eslint/indent": [
170+
"@typescript-eslint/naming-convention": [
171+
"error",
172+
{
173+
"selector": "enumMember",
174+
"format": [
175+
"UPPER_CASE"
176+
]
177+
}
178+
],
179+
"@typescript-eslint/no-empty-interface": "off",
180+
"@typescript-eslint/no-empty-object-type": "off",
181+
"@typescript-eslint/no-extraneous-class": "error",
182+
"@typescript-eslint/no-misused-promises": "off",
183+
"@typescript-eslint/no-non-null-assertion": "off",
184+
"@typescript-eslint/no-parameter-properties": "off",
185+
"@typescript-eslint/no-floating-promises": "error",
186+
"@typescript-eslint/no-shadow": [
187+
"error",
188+
{
189+
"hoist": "never"
190+
}
191+
],
192+
"@typescript-eslint/no-unnecessary-type-assertion": "off",
193+
"@typescript-eslint/no-unused-expressions": "error",
194+
"@typescript-eslint/no-unused-vars": "off",
195+
"@typescript-eslint/no-var-requires": "off",
196+
"@typescript-eslint/only-throw-error": "error",
197+
"@typescript-eslint/prefer-for-of": "off",
198+
"@typescript-eslint/prefer-function-type": "error",
199+
"@typescript-eslint/triple-slash-reference": "off",
200+
"@typescript-eslint/unbound-method": "error",
201+
"@typescript-eslint/unified-signatures": "error",
202+
203+
/* Plugin: @stylistic/ts */
204+
"@stylistic/ts/indent": [
170205
"warn",
171206
2,
172207
{
@@ -191,7 +226,7 @@
191226
"offsetTernaryExpressions": true
192227
}
193228
],
194-
"@typescript-eslint/member-delimiter-style": [
229+
"@stylistic/ts/member-delimiter-style": [
195230
"error",
196231
{
197232
"multiline": {
@@ -203,42 +238,12 @@
203238
}
204239
}
205240
],
206-
"@typescript-eslint/naming-convention": [
207-
"error",
208-
{
209-
"selector": "enumMember",
210-
"format": [
211-
"UPPER_CASE"
212-
]
213-
}
214-
],
215-
"@typescript-eslint/no-empty-interface": "off",
216-
"@typescript-eslint/no-extraneous-class": "error",
217-
"@typescript-eslint/no-misused-promises": "off",
218-
"@typescript-eslint/no-non-null-assertion": "off",
219-
"@typescript-eslint/no-parameter-properties": "off",
220-
"@typescript-eslint/no-floating-promises": "error",
221-
"@typescript-eslint/no-shadow": [
222-
"error",
223-
{
224-
"hoist": "never"
225-
}
226-
],
227-
"@typescript-eslint/no-throw-literal": "error",
228-
"@typescript-eslint/no-unnecessary-type-assertion": "error",
229-
"@typescript-eslint/no-unused-expressions": "error",
230-
"@typescript-eslint/no-unused-vars": "off",
231-
"@typescript-eslint/no-var-requires": "off",
232-
"@typescript-eslint/prefer-for-of": "off",
233-
"@typescript-eslint/prefer-function-type": "error",
234-
"@typescript-eslint/semi": [
241+
"@stylistic/ts/semi": [
235242
"error",
236243
"never"
237244
],
238-
"@typescript-eslint/triple-slash-reference": "off",
239-
"@typescript-eslint/type-annotation-spacing": "error",
240-
"@typescript-eslint/unbound-method": "error",
241-
"@typescript-eslint/unified-signatures": "error",
245+
"@stylistic/ts/type-annotation-spacing": "error",
246+
242247
/* Plugin: eslint-plugin-eslint-comments */
243248
"eslint-comments/no-unused-disable": "error",
244249
"eslint-comments/no-unused-enable": "error",

‎.github/DISCUSSION_TEMPLATE/_.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
> [!NOTE]
6+
>
7+
> **Discussions closed as of November 18, 2025**
8+
>
9+
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
10+
>
11+
> Thank you for your understanding.
12+
>
13+
> In case you have questions not directly related to Material for MkDocs, but to the wider ecosystem, consider creating an issue or a discussion on the respective repository. Here's a list of the most popular ecosystem projects, and their issue trackers and discussion boards:
14+
>
15+
> __MkDocs & Python Markdown__
16+
>
17+
> - [MkDocs] – [Issues][MkDocs issues], [Discussions][MkDocs discussions]
18+
> - [Python Markdown] – [Issues][Python Markdown issues]
19+
> - [Pymdown Extensions] – [Issues][Pymdown Extensions issues], [Discussions][Pymdown Extensions discussions]
20+
>
21+
> __Popular MkDocs plugins__
22+
>
23+
> - [Mike] – [Issues][Mike issues], [Discussions][Mike discussions]
24+
> - [Macros] – [Issues][Macros issues], [Discussions][Macros discussions]
25+
> - [Git Revision Date Localized] – [Issues][Git Revision Date Localized issues]
26+
> - [Awesome Nav] – [Issues][Awesome Nav issues]
27+
> - [Static i18n] – [Issues][Static i18n issues]
28+
> - [MkDocs Literate Nav] – [Issues][MkDocs Literate Nav issues]
29+
>
30+
> [MkDocs]: https://github.com/mkdocs/mkdocs
31+
> [MkDocs issues]: https://github.com/mkdocs/mkdocs/issues
32+
> [MkDocs discussions]: https://github.com/mkdocs/mkdocs/discussions
33+
> [Pymdown Extensions]: https://github.com/facelessuser/pymdown-extensions
34+
> [Pymdown Extensions discussions]: https://github.com/facelessuser/pymdown-extensions/discussions
35+
> [Pymdown Extensions issues]: https://github.com/facelessuser/pymdown-extensions/issues
36+
> [Python Markdown]: https://github.com/Python-Markdown/markdown
37+
> [Python Markdown issues]: https://github.com/Python-Markdown/markdown/issues
38+
> [Mike]: https://github.com/jimporter/mike
39+
> [Mike issues]: https://github.com/jimporter/mike/issues
40+
> [Mike discussions]: https://github.com/jimporter/mike/discussions
41+
> [Macros]: https://github.com/fralau/mkdocs-macros-plugin
42+
> [Macros issues]: https://github.com/fralau/mkdocs-macros-plugin/issues
43+
> [Macros discussions]: https://github.com/fralau/mkdocs-macros-plugin/discussions
44+
> [Git Revision Date Localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
45+
> [Git Revision Date Localized issues]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues
46+
> [Awesome Nav]: https://github.com/lukasgeiter/mkdocs-awesome-nav
47+
> [Awesome Nav issues]: https://github.com/lukasgeiter/mkdocs-awesome-nav/issues
48+
> [Static i18n]: https://github.com/ultrabug/mkdocs-static-i18n
49+
> [Static i18n issues]: https://github.com/ultrabug/mkdocs-static-i18n/issues
50+
> [Static i18n discussions]: https://github.com/ultrabug/mkdocs-static-i18n/discussions
51+
> [MkDocs Literate Nav]: https://github.com/oprypin/mkdocs-literate-nav
52+
> [MkDocs Literate Nav issues]: https://github.com/oprypin/mkdocs-literate-nav/issues
53+
- type: dropdown
54+
id: download
55+
attributes:
56+
label: "​"
57+
options: []
58+
default: 0
59+
validations:
60+
required: true

‎.github/DISCUSSION_TEMPLATE/general.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
> [!NOTE]
6+
>
7+
> **Discussions closed as of November 18, 2025**
8+
>
9+
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
10+
>
11+
> Thank you for your understanding.
12+
>
13+
> In case you have questions not directly related to Material for MkDocs, but to the wider ecosystem, consider creating an issue or a discussion on the respective repository. Here's a list of the most popular ecosystem projects, and their issue trackers and discussion boards:
14+
>
15+
> __MkDocs & Python Markdown__
16+
>
17+
> - [MkDocs] – [Issues][MkDocs issues], [Discussions][MkDocs discussions]
18+
> - [Python Markdown] – [Issues][Python Markdown issues]
19+
> - [Pymdown Extensions] – [Issues][Pymdown Extensions issues], [Discussions][Pymdown Extensions discussions]
20+
>
21+
> __Popular MkDocs plugins__
22+
>
23+
> - [Mike] – [Issues][Mike issues], [Discussions][Mike discussions]
24+
> - [Macros] – [Issues][Macros issues], [Discussions][Macros discussions]
25+
> - [Git Revision Date Localized] – [Issues][Git Revision Date Localized issues]
26+
> - [Awesome Nav] – [Issues][Awesome Nav issues]
27+
> - [Static i18n] – [Issues][Static i18n issues]
28+
> - [MkDocs Literate Nav] – [Issues][MkDocs Literate Nav issues]
29+
>
30+
> [MkDocs]: https://github.com/mkdocs/mkdocs
31+
> [MkDocs issues]: https://github.com/mkdocs/mkdocs/issues
32+
> [MkDocs discussions]: https://github.com/mkdocs/mkdocs/discussions
33+
> [Pymdown Extensions]: https://github.com/facelessuser/pymdown-extensions
34+
> [Pymdown Extensions discussions]: https://github.com/facelessuser/pymdown-extensions/discussions
35+
> [Pymdown Extensions issues]: https://github.com/facelessuser/pymdown-extensions/issues
36+
> [Python Markdown]: https://github.com/Python-Markdown/markdown
37+
> [Python Markdown issues]: https://github.com/Python-Markdown/markdown/issues
38+
> [Mike]: https://github.com/jimporter/mike
39+
> [Mike issues]: https://github.com/jimporter/mike/issues
40+
> [Mike discussions]: https://github.com/jimporter/mike/discussions
41+
> [Macros]: https://github.com/fralau/mkdocs-macros-plugin
42+
> [Macros issues]: https://github.com/fralau/mkdocs-macros-plugin/issues
43+
> [Macros discussions]: https://github.com/fralau/mkdocs-macros-plugin/discussions
44+
> [Git Revision Date Localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
45+
> [Git Revision Date Localized issues]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues
46+
> [Awesome Nav]: https://github.com/lukasgeiter/mkdocs-awesome-nav
47+
> [Awesome Nav issues]: https://github.com/lukasgeiter/mkdocs-awesome-nav/issues
48+
> [Static i18n]: https://github.com/ultrabug/mkdocs-static-i18n
49+
> [Static i18n issues]: https://github.com/ultrabug/mkdocs-static-i18n/issues
50+
> [Static i18n discussions]: https://github.com/ultrabug/mkdocs-static-i18n/discussions
51+
> [MkDocs Literate Nav]: https://github.com/oprypin/mkdocs-literate-nav
52+
> [MkDocs Literate Nav issues]: https://github.com/oprypin/mkdocs-literate-nav/issues
53+
- type: dropdown
54+
id: download
55+
attributes:
56+
label: "​"
57+
options: []
58+
default: 0
59+
validations:
60+
required: true

‎.github/DISCUSSION_TEMPLATE/ideas.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
> [!NOTE]
6+
>
7+
> **Discussions closed as of November 18, 2025**
8+
>
9+
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
10+
>
11+
> Thank you for your understanding.
12+
>
13+
> In case you have questions not directly related to Material for MkDocs, but to the wider ecosystem, consider creating an issue or a discussion on the respective repository. Here's a list of the most popular ecosystem projects, and their issue trackers and discussion boards:
14+
>
15+
> __MkDocs & Python Markdown__
16+
>
17+
> - [MkDocs] – [Issues][MkDocs issues], [Discussions][MkDocs discussions]
18+
> - [Python Markdown] – [Issues][Python Markdown issues]
19+
> - [Pymdown Extensions] – [Issues][Pymdown Extensions issues], [Discussions][Pymdown Extensions discussions]
20+
>
21+
> __Popular MkDocs plugins__
22+
>
23+
> - [Mike] – [Issues][Mike issues], [Discussions][Mike discussions]
24+
> - [Macros] – [Issues][Macros issues], [Discussions][Macros discussions]
25+
> - [Git Revision Date Localized] – [Issues][Git Revision Date Localized issues]
26+
> - [Awesome Nav] – [Issues][Awesome Nav issues]
27+
> - [Static i18n] – [Issues][Static i18n issues]
28+
> - [MkDocs Literate Nav] – [Issues][MkDocs Literate Nav issues]
29+
>
30+
> [MkDocs]: https://github.com/mkdocs/mkdocs
31+
> [MkDocs issues]: https://github.com/mkdocs/mkdocs/issues
32+
> [MkDocs discussions]: https://github.com/mkdocs/mkdocs/discussions
33+
> [Pymdown Extensions]: https://github.com/facelessuser/pymdown-extensions
34+
> [Pymdown Extensions discussions]: https://github.com/facelessuser/pymdown-extensions/discussions
35+
> [Pymdown Extensions issues]: https://github.com/facelessuser/pymdown-extensions/issues
36+
> [Python Markdown]: https://github.com/Python-Markdown/markdown
37+
> [Python Markdown issues]: https://github.com/Python-Markdown/markdown/issues
38+
> [Mike]: https://github.com/jimporter/mike
39+
> [Mike issues]: https://github.com/jimporter/mike/issues
40+
> [Mike discussions]: https://github.com/jimporter/mike/discussions
41+
> [Macros]: https://github.com/fralau/mkdocs-macros-plugin
42+
> [Macros issues]: https://github.com/fralau/mkdocs-macros-plugin/issues
43+
> [Macros discussions]: https://github.com/fralau/mkdocs-macros-plugin/discussions
44+
> [Git Revision Date Localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
45+
> [Git Revision Date Localized issues]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues
46+
> [Awesome Nav]: https://github.com/lukasgeiter/mkdocs-awesome-nav
47+
> [Awesome Nav issues]: https://github.com/lukasgeiter/mkdocs-awesome-nav/issues
48+
> [Static i18n]: https://github.com/ultrabug/mkdocs-static-i18n
49+
> [Static i18n issues]: https://github.com/ultrabug/mkdocs-static-i18n/issues
50+
> [Static i18n discussions]: https://github.com/ultrabug/mkdocs-static-i18n/discussions
51+
> [MkDocs Literate Nav]: https://github.com/oprypin/mkdocs-literate-nav
52+
> [MkDocs Literate Nav issues]: https://github.com/oprypin/mkdocs-literate-nav/issues
53+
- type: dropdown
54+
id: download
55+
attributes:
56+
label: "​"
57+
options: []
58+
default: 0
59+
validations:
60+
required: true

‎.github/DISCUSSION_TEMPLATE/q-a.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
body:
2+
- type: markdown
3+
attributes:
4+
value: |
5+
> [!NOTE]
6+
>
7+
> **Discussions closed as of November 18, 2025**
8+
>
9+
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
10+
>
11+
> Thank you for your understanding.
12+
>
13+
> In case you have questions not directly related to Material for MkDocs, but to the wider ecosystem, consider creating an issue or a discussion on the respective repository. Here's a list of the most popular ecosystem projects, and their issue trackers and discussion boards:
14+
>
15+
> __MkDocs & Python Markdown__
16+
>
17+
> - [MkDocs] – [Issues][MkDocs issues], [Discussions][MkDocs discussions]
18+
> - [Python Markdown] – [Issues][Python Markdown issues]
19+
> - [Pymdown Extensions] – [Issues][Pymdown Extensions issues], [Discussions][Pymdown Extensions discussions]
20+
>
21+
> __Popular MkDocs plugins__
22+
>
23+
> - [Mike] – [Issues][Mike issues], [Discussions][Mike discussions]
24+
> - [Macros] – [Issues][Macros issues], [Discussions][Macros discussions]
25+
> - [Git Revision Date Localized] – [Issues][Git Revision Date Localized issues]
26+
> - [Awesome Nav] – [Issues][Awesome Nav issues]
27+
> - [Static i18n] – [Issues][Static i18n issues]
28+
> - [MkDocs Literate Nav] – [Issues][MkDocs Literate Nav issues]
29+
>
30+
> [MkDocs]: https://github.com/mkdocs/mkdocs
31+
> [MkDocs issues]: https://github.com/mkdocs/mkdocs/issues
32+
> [MkDocs discussions]: https://github.com/mkdocs/mkdocs/discussions
33+
> [Pymdown Extensions]: https://github.com/facelessuser/pymdown-extensions
34+
> [Pymdown Extensions discussions]: https://github.com/facelessuser/pymdown-extensions/discussions
35+
> [Pymdown Extensions issues]: https://github.com/facelessuser/pymdown-extensions/issues
36+
> [Python Markdown]: https://github.com/Python-Markdown/markdown
37+
> [Python Markdown issues]: https://github.com/Python-Markdown/markdown/issues
38+
> [Mike]: https://github.com/jimporter/mike
39+
> [Mike issues]: https://github.com/jimporter/mike/issues
40+
> [Mike discussions]: https://github.com/jimporter/mike/discussions
41+
> [Macros]: https://github.com/fralau/mkdocs-macros-plugin
42+
> [Macros issues]: https://github.com/fralau/mkdocs-macros-plugin/issues
43+
> [Macros discussions]: https://github.com/fralau/mkdocs-macros-plugin/discussions
44+
> [Git Revision Date Localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
45+
> [Git Revision Date Localized issues]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues
46+
> [Awesome Nav]: https://github.com/lukasgeiter/mkdocs-awesome-nav
47+
> [Awesome Nav issues]: https://github.com/lukasgeiter/mkdocs-awesome-nav/issues
48+
> [Static i18n]: https://github.com/ultrabug/mkdocs-static-i18n
49+
> [Static i18n issues]: https://github.com/ultrabug/mkdocs-static-i18n/issues
50+
> [Static i18n discussions]: https://github.com/ultrabug/mkdocs-static-i18n/discussions
51+
> [MkDocs Literate Nav]: https://github.com/oprypin/mkdocs-literate-nav
52+
> [MkDocs Literate Nav issues]: https://github.com/oprypin/mkdocs-literate-nav/issues
53+
- type: dropdown
54+
id: download
55+
attributes:
56+
label: "​"
57+
options: []
58+
default: 0
59+
validations:
60+
required: true

0 commit comments

Comments
 (0)