Skip to content

Commit

Permalink
Add notes about multi-language support.
Browse files Browse the repository at this point in the history
  • Loading branch information
SandeMC authored Oct 29, 2023
1 parent 762265c commit 6b88794
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ For clarity, adhere to the default [markdown rules](https://github.com/markdownl
- [MD033 - Inline HTML](https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md#md033---inline-html)
- When including an emoji in a title, you might encounter the [MD051 - Link fragments should be valid](https://github.com/DavidAnson/markdownlint/blob/main/doc/md051.md#md051---link-fragments-should-be-valid) error. To resolve this, simply exclude the emoji from your link. For example: `#-my-car` would target `🚗 My Car`.

Furthermore, this project also uses [mkdocs-static-i18n](https://github.com/ultrabug/mkdocs-static-i18n/) for multi-language support. All the suggested changes must include a Russian version of the page alongside the English one (by creating `file.en.md` and a `file.ru.md` together). If you're unable to translate the page yourself, create a Draft Pull Request and request for somebody else to translate your page.
- If you wish to add a new language, translate *all* the `markdown` files and follow the documentation on the i18n repository. However, please, before that, create a Pull Request converting the suffix docs structure to the [folder docs structure](https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/#the-folder-docs-structure).

## 🌍 Pull Request Process

If you're ready to contribute:
Expand Down

0 comments on commit 6b88794

Please sign in to comment.