You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please give a detailed description of the bug. Explain where Material
21
22
for MkDocs does not behave as you would expect it to. Be as specific as
22
23
possible. If you have found a workaround or a fix for the problem,
23
-
please let us maintainers (and all other users) know. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
24
+
please let us maintainers (and all other users) know.
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
55
+
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
54
56
.zip file with the reproduction. We reserve the right to close issues
55
-
without .zip files. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
Drag and drop the .zip file with minimal reproduction here.
60
+
Drag and drop the .zip file with the minimal reproduction here.
58
61
validations:
59
62
required: true
60
63
@@ -66,7 +69,8 @@ body:
66
69
Please provide a detailed list of instructions, guiding us maintainers
67
70
through the required steps, helping us to recreate the problem using the
68
71
minimal reproduction you provided. Be as specific as possible and as
69
-
verbose as necessary – try not to leave anything out. [More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
72
+
verbose as necessary – try not to leave anything out.
or indicate where you feel there is a need for improvement. Furthermore,
15
15
explain the severity of the issue, i.e., its impact on you and potentially
16
16
other users.
@@ -23,7 +23,7 @@ body:
23
23
attributes:
24
24
label: Related links
25
25
description: >-
26
-
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material)
26
+
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material/)
27
27
that are impacted by the issue you described above. If applicable,
28
28
add screenshots. Additionally, list links to possibly related open
29
29
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
@@ -51,15 +51,15 @@ body:
51
51
attributes:
52
52
label: Before submitting
53
53
description: >-
54
-
Please ensure your documentation issue report fulfills all of the
55
-
following requirements. If you need clarification on a specific
56
-
requirement, follow the link to learn about it and understand why it is
57
-
necessary before ticking the box. This will save the maintainers and you
54
+
Please ensure your documentation issue fulfills all of the following
55
+
requirements. If you need clarification on a specific requirement,
56
+
follow the link to learn about it and understand why it is necessary
57
+
before ticking the box. This will save the maintainers and you
58
58
valuable time.
59
59
options:
60
60
- label: >-
61
-
I have read and followed the [documentation issue reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
61
+
I have read and followed the [documentation issue guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
62
62
required: true
63
63
- label: >-
64
-
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)
64
+
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)
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).
91
91
required: true
92
92
- label: >-
93
-
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
93
+
I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material/), related [issues](https://github.com/squidfunk/mkdocs-material/issues),
94
94
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
0 commit comments