Updated guides

This commit is contained in:
katharinalisalin
2023-04-04 14:58:40 +02:00
parent 270129abcb
commit 268c5066ba
8 changed files with 598 additions and 224 deletions

View File

@@ -7,17 +7,21 @@ body:
- type: markdown
attributes:
value: >-
**Important**: Before creating a new translation, please make sure that
Material for MkDocs does not already include support for your language.
Please check the list of all [available languages](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language)
and help us by adding missing translations.
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, e.g. "Copy to clipboard", etc.
description: >-
Please translate the labels on the right. For new languages, translate
each line. For existing languages, only translate lines containing the
icon :arrow_left: and remove the icon before submitting.
[More](https://squidfunk.github.io/mkdocs-material/contributing/adding-a-translation/#translations)
value: |-
{% macro t(key) %}{{ {
"language": "en",
@@ -63,19 +67,30 @@ body:
validations:
required: true
- type: textarea
id: country-flag
attributes:
label: Country flag icon
description: >-
Please add the flag of the country when adding a new language. Select
it on our [Icons, Emojis site](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search)
by entering `flag` in the search field. If your flag is not provided by
Twemoji, please choose the closest matching flag.
[More](https://squidfunk.github.io/mkdocs-material/contributing/adding-a-translation/#country-flag)
placeholder: |-
Post the flag of the country here.
- type: checkboxes
id: checklist
attributes:
label: Before submitting
description: >-
Please ensure that your translation fulfills the following
requirements.
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 my best knowledge.
- label: I have assured that, to the best of my knowledge, the translations are accurate.
required: true
- label: >-
__Optional__: I want to integrate this translation myself and create a
pull request following the [contribution guide](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md).