From 2cfb895c0d7024e397a8fd759f3b611f99937a8a Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 11 Nov 2025 13:02:38 +0100 Subject: [PATCH] Documentation --- .github/ISSUE_TEMPLATE/01-report-a-bug.yml | 2 +- .../ISSUE_TEMPLATE/03-request-a-change.yml | 95 --------------- .../ISSUE_TEMPLATE/04-add-translations.yml | 111 ------------------ docs/setup/changing-the-language.md | 8 -- 4 files changed, 1 insertion(+), 215 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/03-request-a-change.yml delete mode 100644 .github/ISSUE_TEMPLATE/04-add-translations.yml diff --git a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml index f1985d3b4..7658f4e10 100644 --- a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml +++ b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml @@ -1,4 +1,4 @@ -name: Report a bug +name: Report a critical bug description: Something is not working? Report a bug body: diff --git a/.github/ISSUE_TEMPLATE/03-request-a-change.yml b/.github/ISSUE_TEMPLATE/03-request-a-change.yml deleted file mode 100644 index a2c4dfb5b..000000000 --- a/.github/ISSUE_TEMPLATE/03-request-a-change.yml +++ /dev/null @@ -1,95 +0,0 @@ -name: Request a change -description: Want to submit an idea? Propose a change or feature request -body: - - - type: textarea - id: context - attributes: - label: Context - description: >- - 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) - - - type: textarea - id: description - attributes: - label: Description - description: >- - Please provide a detailed description of your idea in 2-3 sentences so - that we maintainers can fully understand what change, feature, or the - improvement you are proposing. Don't yet explain the benefits of your - idea, we'll come to that. Focus on functionality. - [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#description) - validations: - required: true - - - type: textarea - id: related-links - attributes: - label: Related links - description: >- - Please list all links to open and closed [issues](https://github.com/squidfunk/mkdocs-material/issues), - [discussions](https://github.com/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://github.com/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: |- - - [Requesting a change](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/) - - - validations: - required: true - - - type: textarea - id: use-cases - attributes: - label: Use Cases - 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 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: - required: true - - - type: textarea - id: visuals - attributes: - label: Visuals - description: >- - This field is optional. You may provide sketches, screenshots, mockups, - or external assets to illustrate your idea. If you have seen this change, - feature, or improvement used in other static site generators or themes, - please describe how it is implemented and advertised. - [More](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#visuals) - placeholder: |- - Drag and drop images here or link external assets. - - - type: checkboxes - id: checklist - attributes: - label: Before submitting - description: - Please ensure your idea fulfills all of the following requirements. If - you need clarification on a specific requirement, follow the link to - learn about it and understand why it is necessary before ticking the box. - This will save the maintainers and you valuable time. - options: - - label: >- - I have read and followed the [change request guidelines](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/). - required: true - - label: >- - I have verified that [my idea is a change request and not a bug report](https://squidfunk.github.io/mkdocs-material/contributing/requesting-a-change/#its-not-a-bug-its-a-feature). - required: true - - label: >- - 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://github.com/squidfunk/mkdocs-material/issues), - and [discussions](https://github.com/squidfunk/mkdocs-material/discussions) to underline the need for my idea. - required: true diff --git a/.github/ISSUE_TEMPLATE/04-add-translations.yml b/.github/ISSUE_TEMPLATE/04-add-translations.yml deleted file mode 100644 index 42c10f287..000000000 --- a/.github/ISSUE_TEMPLATE/04-add-translations.yml +++ /dev/null @@ -1,111 +0,0 @@ -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://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md). diff --git a/docs/setup/changing-the-language.md b/docs/setup/changing-the-language.md index 2ee216e7a..e61ad4b33 100644 --- a/docs/setup/changing-the-language.md +++ b/docs/setup/changing-the-language.md @@ -34,17 +34,9 @@ The following languages are supported: Note that some languages will produce unreadable anchor links due to the way the default slug function works. Consider using a [Unicode-aware slug function]. -!!! tip "Translations missing? Help us out, it takes only 5 minutes" - - Material for MkDocs relies on outside contributions for adding and updating - translations for the more than 60 languages it supports. If your language - shows that some translations are missing, click on the link to add them. If - your language is not in the list, click here to [add a new language]. - [single language per document]: https://www.w3.org/International/questions/qa-html-language-declarations.en#attributes [language selector]: #site-language-selector [Unicode-aware slug function]: extensions/python-markdown.md#+toc.slugify - [add a new language]: https://github.com/squidfunk/mkdocs-material/issues/new?template=04-add-a-translation.yml&title=Add+translations+for+... ### Site language selector