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

112 lines
5.0 KiB
YAML
Raw Normal View History

2023-01-29 22:18:49 +03:00
name: Add a translation
2023-01-29 22:52:00 +03:00
description: Missing support for your language? Add a translation
title: Add translations for ...
2023-01-29 22:18:49 +03:00
labels:
2023-01-30 01:04:28 +03:00
- change request
body:
2023-01-29 22:52:00 +03:00
- type: markdown
2021-06-29 12:06:39 +03:00
attributes:
2023-09-21 16:26:41 +03:00
value: >-
2023-04-04 15:58:40 +03:00
**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.
2023-01-29 22:52:00 +03:00
2021-06-29 12:06:39 +03:00
- type: textarea
2023-01-28 21:05:12 +03:00
id: translations
2021-06-29 12:06:39 +03:00
attributes:
2023-01-28 21:05:12 +03:00
label: Translations
2023-04-04 15:58:40 +03:00
description: >-
Please translate the labels on the right. For new languages, translate
each line. For existing languages, only translate lines containing the
2023-09-21 16:33:49 +03:00
:arrow_left: icon and remove the icon before submitting.
2023-09-21 16:23:22 +03:00
[More](https://squidfunk.github.io/mkdocs-material/contributing/adding-translations/#translations_1)
2021-06-29 12:06:39 +03:00
value: |-
{% macro t(key) %}{{ {
2023-09-21 16:33:49 +03:00
"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 ⬅️"
2021-06-29 12:06:39 +03:00
}[key] }}{% endmacro %}
2023-01-28 21:05:12 +03:00
render: Jinja
2021-06-29 12:06:39 +03:00
validations:
required: true
2023-01-29 22:54:24 +03:00
2023-09-21 16:19:31 +03:00
- type: input
2023-04-04 15:58:40 +03:00
id: country-flag
attributes:
2023-09-21 16:23:22 +03:00
label: Country flag
2023-04-04 15:58:40 +03:00
description: >-
2023-09-21 16:28:46 +03:00
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
2023-09-21 16:23:22 +03:00
included, please choose the most appropriate available flag.
[More](https://squidfunk.github.io/mkdocs-material/contributing/adding-translations/#country-flag)
2023-04-04 15:58:40 +03:00
placeholder: |-
2023-09-21 16:23:22 +03:00
Country flag shortcode, e.g. :flag_en:
2023-04-04 15:58:40 +03:00
2023-01-29 22:54:24 +03:00
- type: checkboxes
id: checklist
attributes:
label: Before submitting
description: >-
2023-04-04 15:58:40 +03:00
Please ensure that your translation fulfills the following requirements.
2023-01-29 22:54:24 +03:00
options:
2023-09-21 16:23:22 +03:00
- label: >-
I've checked the list of [available languages](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language) for existing translations.
2023-01-29 22:54:24 +03:00
required: true
2023-09-21 16:26:41 +03:00
- label: >-
2023-09-21 16:23:22 +03:00
I assure that the translations are accurate to the best of my knowledge.
2023-01-29 22:54:24 +03:00
required: true
2023-01-30 16:10:43 +03:00
- 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).