translating admonitions

docs/setup/index.md

@@ -29,6 +29,7 @@ This plugin uses MkDocs event priority in order to reconfigure each of the build
 |on_nav|-100|
 |on_env|0|
 |on_template_context|50|
+|on_page_markdown|50|
 |on_page_context|50|
 |on_post_page|-100|
 |on_post_build|-100|

docs/setup/setting-up-languages.md

@@ -32,6 +32,7 @@ plugins:
 |link|no|`/<locale>/`|Used for the `mkdocs-material` language switcher. Absolute path used as the base of the language switcher|
 |fixed_link|no||Used for the `mkdocs-material` language switcher. Fixed URL link used in the language switcher for this language|
 |nav_translations|no||Key/value mapping used to [translate navigation items](localizing-navigation.md)|
+|admonition_translations|no||Key/value mapping used to [translate admonitions](translating-content.md)|
 
 Minimal example with two languages:
 

docs/setup/translating-content.md

@@ -30,3 +30,42 @@ site
 Which means that the `image.png` and its `fr/image.png` localized counterpart can be referenced the same way as `![my image](image.png)` on both `index.md` and `index.fr.md` when using the `suffix` docs structure.
 
 It works the same for the `folder` structure!
+
+
+## Translating admonitions
+
+This sub-option is a key/value mapping set per language and allows you to translate [admonition](https://python-markdown.github.io/extensions/admonition/) titles which don't have an explicit title defined.
+
+### Language Sub-Option: `admonition_translations`
+
+This example overrides admonition titles of the French version of the site.
+
+``` yaml
+plugins:
+  - i18n:
+    languages:
+      - locale: en
+        default: true
+        name: English
+      - locale: fr
+        name: Français
+        admonition_translations:
+          - tip: Conseil
+          - warning: Avertissement
+```
+
+and translates French markdowns from:
+
+```
+!!! tip
+
+    Bonjour le monde
+```
+
+to:
+
+```
+!!! tip "Conseil"
+
+    Bonjour le monde
+```

mkdocs_static_i18n/config.py

@@ -37,6 +37,7 @@ class I18nPluginLanguage(Config):
     name = config_options.Type(str)
     nav = config_options.Optional(config_options.Nav())
     nav_translations = config_options.Optional(config_options.Type(dict))
+    admonition_translations = config_options.Optional(config_options.Type(dict))
     site_author = config_options.Optional(config_options.Type(str))
     site_description = config_options.Optional(config_options.Type(str))
     site_name = config_options.Optional(config_options.Type(str))

mkdocs_static_i18n/plugin.py

@@ -1,4 +1,5 @@
 import logging
+import re
 import sys
 from pathlib import PurePath
 from typing import Optional
@@ -124,6 +125,38 @@ def on_template_context(self, context, template_name, config):
         context["i18n_alternates"] = self.i18n_files_per_language
         return context
 
+    @plugins.event_priority(50)
+    def on_page_markdown(self, markdown, page, config, files):
+        """
+        The page_markdown event is called after the page's markdown is loaded from file
+        and can be used to alter the Markdown source text.
+
+        Here we translate admonition types
+        """
+        admonition_translations = self.current_language_config.admonition_translations or {}
+        if len(admonition_translations) > 0 and (
+            "markdown_extensions" not in config or "admonition" not in config["markdown_extensions"]
+        ):
+            log.warning(
+                "admonition_translations used, but admonitions won't be rendered properly without 'admonition' in mkdocs.yml's markdown_extensions."
+            )
+        RE = re.compile(
+            r'^(!!! ?)([\w\-]+(?: +[\w\-]+)*)(?: +"(.*?)")? *$'
+        ) # Copied from https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/admonition.py and modified for a single-line processing
+        out = []
+        for line in markdown.splitlines():
+            m = RE.match(line)
+            if m:
+                type = m.group(2)
+                if (
+                    m.group(3) is None or m.group(3).strip() == ''
+                ) and type in admonition_translations:
+                    title = admonition_translations[type]
+                    line = m.group(1) + m.group(2) + f' "{title}"'
+            out.append(line)
+        markdown = "\n".join(out)
+        return markdown
+
     @plugins.event_priority(50)
     def on_page_context(self, context, page, config, nav):
         """

tests/admonitions/index.fr.md

@@ -0,0 +1,13 @@
+# Page d'accueil (french version)
+
+!!! tip
+    Titre implicite dérivé du type d'avertissement, peut être remplacé en définissant `admonition_translations`
+
+!!!tip
+    Pareil sans espaces
+
+!!! warning
+    Titre implicite dérivé du type d'avertissement, peut être remplacé en définissant `admonition_translations`
+
+!!! warning "Heey"
+    Titre explicite, n'est pas traduit par `admonition_translations`

tests/admonitions/index.md

@@ -0,0 +1,13 @@
+# Home page
+
+!!! tip
+    Implicit title derived from admonition type, can be overriden by setting `admonition_translations`
+
+!!!tip
+    Same without space
+
+!!! warning
+    Implicit title derived from admonition type, can be overriden by setting `admonition_translations`
+
+!!! warning "Heey"
+    Explicit title, isn't translated by `admonition_translations`

tests/test_admonitions.py

@@ -0,0 +1,44 @@
+import re
+from pathlib import Path
+
+from mkdocs.commands.build import build
+from mkdocs.config.base import load_config
+
+def test_plugin_no_use_directory_urls_default_language_only():
+    mkdocs_config = load_config(
+        "tests/mkdocs.yml",
+        theme={"name": "material"},
+        docs_dir="admonitions/",
+        plugins={
+            "i18n": {
+                "languages": [
+                    {
+                        "locale": "en",
+                        "name": "english",
+                        "default": True,
+                    },
+                    {
+                        "locale": "fr",
+                        "name": "français",
+                        "build": True,
+                        "admonition_translations": {
+                            "tip": "Conseil",
+                            "warning": "Avertissement",
+                        }
+                    },
+                ],
+            },
+        },
+        markdown_extensions=["admonition"],
+    )
+    build(mkdocs_config)
+    site_dir = mkdocs_config["site_dir"]
+    generate_site = [f.relative_to(site_dir) for f in Path(site_dir).glob("**/*.html")]
+
+    with open(site_dir+'/index.html') as f:
+        admonition_titles = re.findall(r"<p class=[\"']admonition-title[\"']>([^<]*)", f.read())
+        assert(admonition_titles == ['Tip', 'Tip', 'Warning', 'Heey'])
+
+    with open(site_dir+'/fr/index.html') as f:
+        admonition_titles = re.findall(r"<p class=[\"']admonition-title[\"']>([^<]*)", f.read())
+        assert(admonition_titles == ['Conseil', 'Conseil', 'Avertissement', 'Heey'])

tests/test_languages_option.py

@@ -78,6 +78,7 @@ def test_plugin_languages_dual_lang():
             "default": True,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,
@@ -95,6 +96,7 @@ def test_plugin_languages_dual_lang():
             "default": False,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,
@@ -136,6 +138,7 @@ def test_plugin_languages_one_lang():
             "default": True,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,
@@ -202,6 +205,7 @@ def test_plugin_languages_dual_lang_with_null():
             "default": True,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,
@@ -219,6 +223,7 @@ def test_plugin_languages_dual_lang_with_null():
             "default": False,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,
@@ -236,6 +241,7 @@ def test_plugin_languages_dual_lang_with_null():
             "default": False,
             "nav": None,
             "nav_translations": None,
+            "admonition_translations": None,
             "theme": None,
             "site_name": None,
             "copyright": None,