Mkdocs-material: Call for Contributions: Add languages/translations to Material

Created on 19 Oct 2017  ·  17Comments  ·  Source: squidfunk/mkdocs-material

Please follow this link to propose a new translation

Call for Contributions: translating Material for MkDocs

This is a call for contributions to add translations to Material for MkDocs. Default translations are a much requested feature. #507 finally adds the ability to set the language via mkdocs.yml:

theme:
  language: 'de'

Our progress so far:

  • [x] English en (Source)
  • [x] German de (Source)
  • [x] Danish da (Source) thanks to @jonas
  • [x] Polish pl (Source) thanks to @makshh
  • [x] Swedish sv (Source) thanks to @martinbira
  • [x] Spanish es (Source) thanks to @aliciaphes
  • [x] Portguese pt (Source) thanks to @argenta-web
  • [x] French fr (Source) thanks to @mvertes
  • [x] Italian it (Source) thanks to @markainick
  • [x] Norwegian no (Source) thanks to @oddcb
  • [x] Chinese (Simplified) zh (Source) thanks to @cxlwill
  • [x] Chinese (Traditional) zh-Hant (Source) thanks to @cxlwill
  • [x] Korean kr (Source) thanks to @ChoJH
  • [x] Russian ru (Source) thanks to @leonidboykov
  • [x] Japanese ja (Source) thanks to @miyahan
  • [x] Dutch nl (Source) thanks to @Elvander
  • [x] Turkish tr (Source) thanks to @gurolg
  • [x] Ukrainian uk (Source) thanks to @Serg2294
  • [ ] Finnish fi
  • [ ] Romanian ro
  • [ ] Hungarian hu
  • [ ] Feel free to add more languages...

Option 1: submit a PR

Feel free to add your language in a PR by copying the English translations and adjusting the labels:

cp partials/language/en.html partials/language/ru.html

Then adjust all translations to match your language:

{% macro t(key) %}{{ {
  "language": "ru",
  ...
}[key] }}{% endmacro %}

Then build the theme and submit a PR.

Option 2: post translations in this thread

Alternatively just post the translations in this thread starting with:

<!-- Translations: English -->
{% macro t(key) %}{{ {
  "language": "en",
  "clipboard.copy": "Copy to clipboard",
  "clipboard.copied": "Copied to clipboard",
  "edit.link.title": "Edit this page",
  "footer.previous": "Previous",
  "footer.next": "Next",
  "meta.comments": "Comments",
  "meta.source": "Source",
  "search.placeholder": "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.tokenizer": "[\s\-]+",
  "source.link.title": "Go to repository",
  "toc.title": "Table of contents"
}[key] }}{% endmacro %}
help wanted
Source
picture squidfunk

All 17 comments

French translation below

<!-- Translations: French -->
{% macro t(key) %}{{ {
  "language": "fr",
  "clipboard.copy": "Copier dans le presse-papier",
  "clipboard.copied": "Copié dans le presse-papier",
  "edit.link.title": "Editer cette page",
  "footer.previous": "Précédent",
  "footer.next": "Suivant",
  "meta.comments": "Commentaires",
  "meta.source": "Source",
  "search.placeholder": "Rechercher",
  "search.result.placeholder": "Entrer pour démarrer la recherche",
  "search.result.none": "Aucun document trouvé",
  "search.result.one": "1 document trouvé",
  "search.result.other": "# documents trouvés",
  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Aller au dépôt",
  "toc.title": "Table des matières"
}[key] }}{% endmacro %}
mvertes picture mvertes on 20 Oct 2017
👍1

Below is the Korean translation.

<!-- Translations: Korean -->
{% macro t(key) %}{{ {
  "language": "kr",
  "clipboard.copy": "클립보드로 복사",
  "clipboard.copied": "클립보드에 복사됨",
  "edit.link.title": "이 페이지를 편집",
  "footer.previous": "이전",
  "footer.next": "다음",
  "meta.comments": "댓글",
  "meta.source": "출처",
  "search.placeholder": "검색",
  "search.result.placeholder": "검색어를 입력하세요",
  "search.result.none": "검색어와 일치하는 문서가 없습니다",
  "search.result.one": "1개의 일치하는 문서",
  "search.result.other": "#개의 일치하는 문서",
  "search.tokenizer": "[\s\-]+",
  "source.link.title": "저장소로 이동",
  "toc.title": "목차"
}[key] }}{% endmacro %}
ChoJH picture ChoJH on 29 Oct 2017
👍1

Russian translation.

<!-- Translation: Russian -->
{% macro t(key) %}{{ {
  "language": "ru",
  "clipboard.copy": "Копировать в буфер",
  "clipboard.copied": "Скопировано в буфер",
  "edit.link.title": "Редактировать страницу",
  "footer.previous": "Назад",
  "footer.next": "Вперед",
  "meta.comments": "Комментарии",
  "meta.source": "Исходный код",
  "search.placeholder": "Поиск",
  "search.result.placeholder": "Начните печатать для поиска",
  "search.result.none": "Совпадений не найдено",
  "search.result.one": "Найдено 1 совпадение",
  "search.result.other": "Найдено # совпадений",
  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Перейти к репозиторию",
  "toc.title": "Содержание"
}[key] }}{% endmacro %}
leonidboykov picture leonidboykov on 1 Nov 2017
👍1

Brazilian Portuguese translation:

<!-- Translations: Portuguese -->
{% macro t(key) %}{{ {
  "language": "pt",
  "clipboard.copy": "Copiar para área de transferência",
  "clipboard.copied": "Copiado para área de transferência",
  "edit.link.title": "Editar esta página",
  "footer.previous": "Anterior",
  "footer.next": "Próximo",
  "meta.comments": "Comentários",
  "meta.source": "Fonte",
  "search.placeholder": "Buscar",
  "search.result.placeholder": "Digite para iniciar a busca",
  "search.result.none": "Nenhum resultado encontrado",
  "search.result.one": "1 resultado encontrado",
  "search.result.other": "# resultados encontrados",
  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Ir ao repositório",
  "toc.title": "Índice"
}[key] }}{% endmacro %}
argenta-ma picture argenta-ma on 12 Nov 2017
👍1

666 implements skip links, so we have a new phrase that needs to be translated:

English:

Skip to content

German:

Zum Inhalt

I would kindly ask all contributors to translate the term into their respective language inside this thread. I will add the translations to the theme.

  • [x] English en (Source)
  • [x] German de (Source)
  • [x] Danish da (Source) thanks to @jonas
  • [x] Polish pl (Source) thanks to @makshh
  • [x] Swedish sv (Source) thanks to @martinbira
  • [x] Spanish es (Source) thanks to @aliciaphes
  • [x] Portguese pt (Source) thanks to @argenta-web
  • [ ] French fr (Source) thanks to @mvertes
  • [x] Italian it (Source) thanks to @markainick
  • [x] Norwegian no (Source) thanks to @oddcb
  • [x] Chinese (Simplified) zh (Source) thanks to @cxlwill
  • [x] Chinese (Traditional) zh-Hant (Source) thanks to @cxlwill
  • [ ] Korean kr (Source) thanks to @ChoJH
  • [x] Russian ru (Source) thanks to @leonidboykov
  • [ ] Japanese ja (Source) thanks to @miyahan
  • [x] Dutch nl (Source) thanks to @Elvander
  • [ ] Turkish tr (Source) thanks to @gurolg
squidfunk picture squidfunk on 18 Jan 2018

Polish (skip to content): Przejdź do treści

max-ci picture max-ci on 19 Jan 2018
👍1

Norwegian (skip to content): Gå til innholdet

oddcb picture oddcb on 19 Jan 2018
👍1

Swedish (skip to content): Gå till innehållet

martinbira picture martinbira on 19 Jan 2018
👍1

Danish: Gå til indholdet

Jonas Fonseca

jonas picture jonas on 19 Jan 2018
👍1

Simplified Chinese: 跳转至
Traditional Chinese: 跳轉至

cxlwill picture cxlwill on 19 Jan 2018
👍1

Russian (skip to content): Перейти к содержанию

leonidboykov picture leonidboykov on 19 Jan 2018
👍1

Portuguese: Ir para o conteúdo

--
Marco André Argenta, Dr.
Professor Adjunto - Departamento de Construção Civil
Programa de Pós-Graduação em Engenharia de Construção Civil - PPGECC
Universidade Federal do Paraná - UFPR
www.estruturas.ufpr.br
www.ppgcc.ufpr.br
www.dcc.ufpr.br
+55 41 3361-3447/3218

2018-01-18 18:57 GMT-02:00 Martin Donath notifications@github.com:

666 https://github.com/squidfunk/mkdocs-material/pull/666 implements

skip links, so we have a new phrase that needs to be translated:

English:

Skip to content

German:

Zum Inhalt

I would kindly ask all contributors to translate the term into their
respective language inside this thread. I will add the translations to the
theme.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/squidfunk/mkdocs-material/issues/509#issuecomment-358779213,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AQtG_O4vRK-WUR7BBPN4Wc02xsVpS4olks5tL7BCgaJpZM4P_t8B
.

argenta-ma picture argenta-ma on 19 Jan 2018
👍1

italian: Vai al contenuto

markainick picture markainick on 19 Jan 2018
👍1

Dutch: Ga naar inhoud

Elvander picture Elvander on 20 Jan 2018
👍1

Ukrainian translation below

<!-- Translation: Ukrainian -->
{% macro t(key) %}{{ {
  "language": "ua",
  "clipboard.copy": "Скопіювати в буфер",
  "clipboard.copied": "Скопійовано в буфер",
  "edit.link.title": "Редагувати сторінку",
  "footer.previous": "Назад",
  "footer.next": "Вперед",
  "meta.comments": "Коментарі",
  "meta.source": "Вихідний код",
  "search.placeholder": "Пошук",
  "search.result.placeholder": "Розпочніть писати для пошуку",
  "search.result.none": "Збігів не знайдено",
  "search.result.one": "Знайдено 1 збіг",
  "search.result.other": "Знайдено # збігів",
  "search.tokenizer": "[\s\-]+",
  "source.link.title": "Перейти до репозиторію",
  "toc.title": "Зміст"
}[key] }}{% endmacro %}

Ukrainian (skip to content): перейти до змісту

Serg2294 picture Serg2294 on 24 Jan 2018

All skip to content translations were already included with 2.5.1, Ukrainian is about to be released in a second with 2.5.3. Thanks guys!

squidfunk picture squidfunk on 25 Jan 2018

I'm closing this issue and would like to thank all contributors for a jump start in translating the theme. Some skip-to-content link translations are still missing, but that's not a big deal because Material now always falls back to English.

I added an Admonition to the landing page of the documentation which points to a pre-filled GitHub issue. Please use this approach to submit new translations. I think this approach should work best.

squidfunk picture squidfunk on 25 Jan 2018
Was this page helpful?
0 / 5 - 0 ratings

Related issues

danierutu picture danierutu  ·  3Comments
NJAldwin picture NJAldwin  ·  3Comments
ngtrian picture ngtrian  ·  3Comments
michael-nok picture michael-nok  ·  3Comments
atmarx picture atmarx  ·  4Comments