search

ultrabug / mkdocs-static-i18n

MkDocs i18n plugin using static translation markdown files
https://ultrabug.github.io/mkdocs-static-i18n/
MIT License
238 stars 38 forks source link

What base_path to use so that includes are -- well -- included? #312

Open mgriff88 opened 3 months ago

mgriff88 commented 3 months ago

I have a mkdocs site available in both English and Japanese. It's structured like so:

- docs/
    - en/
           - file1.md
           - file2.md
           - includes/
                - include1.md
                - include2.md
     - ja/
           - file1.md
           - file2.md
           - includes/
                - include1.md
                - include2.md

I use the markdown-include plugin for placing those includes throughout my docs. Typically I just call upon it like [!./includes/include1.md!].

But, because you have to set a base_path for the includes, this is breaking mkdocs-static-i18n. Just setting the base_path as docs doesn't work -- it has to be docs/en or docs/ja. But, then you have to pick one language or the other, which defeats the purpose of the localized site.

image

Is there someway to tell another plugin that it should be using whatever two-letter i18n code in that base_path, relative to what site it's on? Something like docs/**?