Merge branch 'master' into fix/instant-loading

.dockerignore

@@ -22,6 +22,6 @@
 .git
 .github
 docs
-material/.overrides
+material/overrides
 node_modules
 src

.editorconfig

@@ -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

.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,7 +32,7 @@ body:
  label: Related links
  description: >-
  Please list all links to the sections of
- [our documentation](https://squidfunk.github.io/mkdocs-material) that
+ [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:/squidfunk/mkdocs-material/issues)
@@ -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 the .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:/squidfunk/mkdocs-material/issues)
  and [discussions](https:/squidfunk/mkdocs-material/discussions).
  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,7 +10,7 @@ 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., its impact on you and potentially
  other users.
@@ -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:/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,7 +10,8 @@ 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
@@ -32,10 +33,9 @@ body:
  description: >-
  Please list all links to open and closed [issues](https:/squidfunk/mkdocs-material/issues),
  [discussions](https:/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:/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:/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: |-
@@ -51,7 +51,7 @@ body:
  description: >-
  Please explain how your idea will work from an author's and user's
  perspective. Elaborate on how the change would positively impact not only
- you but the community and how it aligns with the goals and [philosophy](https://squidfunk.github.io/mkdocs-material/philosophy/)
+ 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:
@@ -90,6 +90,6 @@ body:
  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:/squidfunk/mkdocs-material/issues),
+ I have included relevant links to [the documentation](https://squidfunk.github.io/mkdocs-material/), related [issues](https:/squidfunk/mkdocs-material/issues),
  and [discussions](https:/squidfunk/mkdocs-material/discussions) to underline the need for my idea.
  required: true

.github/ISSUE_TEMPLATE/04-add-translations.yml

@@ -0,0 +1,111 @@
+name: Add a translation
+description: Missing support for your language? Add a translation
+title: Add translations for ...
+labels:
+ - change request
+body:
+
+ - type: markdown
+ attributes:
+ value: >-
+ **Important**: Before creating a new translation, please check if
+ Material for MkDocs already supports your language. Review the list of
+ [available languages](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language),
+ pick your language to add new or improve existing translations.
+
+ - type: textarea
+ id: translations
+ attributes:
+ label: Translations
+ description: >-
+ Please translate the labels on the right. For new languages, translate
+ each line. For existing languages, only translate lines containing the
+ :arrow_left: icon and remove the icon before submitting.
+ [More](https://squidfunk.github.io/mkdocs-material/contributing/adding-translations/#translations_1)
+ value: |-
+ {% macro t(key) %}{{ {
+ "language": "en ⬅️",
+ "direction": "ltr ⬅️",
+ "action.edit": "Edit this page ⬅️",
+ "action.skip": "Skip to content ⬅️",
+ "action.view": "View source of this page ⬅️",
+ "announce.dismiss": "Don't show this again ⬅️",
+ "blog.archive": "Archive ⬅️",
+ "blog.categories": "Categories ⬅️",
+ "blog.categories.in": "in ⬅️",
+ "blog.continue": "Continue reading ⬅️",
+ "blog.draft": "Draft ⬅️",
+ "blog.index": "Back to index ⬅️",
+ "blog.meta": "Metadata ⬅️",
+ "blog.references": "Related links ⬅️",
+ "clipboard.copy": "Copy to clipboard ⬅️",
+ "clipboard.copied": "Copied to clipboard ⬅️",
+ "consent.accept": "Accept ⬅️",
+ "consent.manage": "Manage settings ⬅️",
+ "consent.reject": "Reject ⬅️",
+ "footer": "Footer ⬅️",
+ "footer.next": "Next ⬅️",
+ "footer.previous": "Previous ⬅️",
+ "header": "Header ⬅️",
+ "meta.comments": "Comments ⬅️",
+ "meta.source": "Source ⬅️",
+ "nav": "Navigation ⬅️",
+ "readtime.one": "1 min read ⬅️",
+ "readtime.other": "# min read ⬅️",
+ "rss.created": "RSS feed ⬅️",
+ "rss.updated": "RSS feed of updated content ⬅️",
+ "search": "Search ⬅️",
+ "search.placeholder": "Search ⬅️",
+ "search.share": "Share ⬅️",
+ "search.reset": "Clear ⬅️",
+ "search.result.initializer": "Initializing search ⬅️",
+ "search.result.placeholder": "Type to start searching ⬅️",
+ "search.result.none": "No matching documents ⬅️",
+ "search.result.one": "1 matching document ⬅️",
+ "search.result.other": "# matching documents ⬅️",
+ "search.result.more.one": "1 more on this page ⬅️",
+ "search.result.more.other": "# more on this page ⬅️",
+ "search.result.term.missing": "Missing ⬅️",
+ "select.language": "Select language ⬅️",
+ "select.version": "Select version ⬅️",
+ "source": "Go to repository ⬅️",
+ "source.file.contributors": "Contributors ⬅️",
+ "source.file.date.created": "Created ⬅️",
+ "source.file.date.updated": "Last update ⬅️",
+ "tabs": "Tabs ⬅️",
+ "toc": "Table of contents ⬅️",
+ "top": "Back to top ⬅️"
+ }[key] }}{% endmacro %}
+ render: Jinja
+ validations:
+ required: true
+
+ - type: input
+ id: country-flag
+ attributes:
+ label: Country flag
+ description: >-
+ This field is optional. Please add the flag of the country when adding a
+ new language. Go to our [emoji search](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search)
+ and enter `flag` to find all available shortcodes. If your flag is not
+ included, please choose the most appropriate available flag.
+ [More](https://squidfunk.github.io/mkdocs-material/contributing/adding-translations/#country-flag)
+ placeholder: |-
+ Country flag shortcode, e.g. :flag_en:
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Before submitting
+ description: >-
+ Please ensure that your translation fulfills the following requirements.
+ options:
+ - label: >-
+ I've checked the list of [available languages](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language) for existing translations.
+ required: true
+ - label: >-
+ I assure that the translations are accurate to the best of my knowledge.
+ required: true
+ - label: >-
+ __Optional__: I want to integrate this translation myself and create a
+ pull request following the [contribution guide](https:/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md).

.github/ISSUE_TEMPLATE/config.yml

@@ -22,4 +22,6 @@ blank_issues_enabled: false
 contact_links:
  - name: Ask a question
  url: https:/squidfunk/mkdocs-material/discussions
- about: Have a question or need help? Connect with the community on our discussion board
+ about: >
+ Have a question or need help? Connect with our community on the
+ discussion board