Possibility to localize external links

ultrabug / mkdocs-static-i18n

MkDocs i18n plugin using static translation markdown files

https://ultrabug.github.io/mkdocs-static-i18n/

MIT License

228 stars 38 forks source link

Possibility to localize external links #158

Closed UlricusR closed 1 year ago

UlricusR commented 1 year ago

Problem description:

Multilingual website uses external links, included via the mkdocs nav configuration
Some of these links differ from language to language, e.g., if website is displayed in English, the external link should (assuming localizations of the external website are available) also point to the English localization, if displayed in French, to the French localization

Solution proposal:

Extend nav_translations with the option to include not only a translation string, but also a URL

UlricusR commented 1 year ago

See https://ulricusr.github.io/ for a live example (website still under development - see the "EasyFPU for iOS" link). I needed this feature to connect my GitHub user site to my GitHub project site, using the same language.

ultrabug commented 1 year ago

Hi @UlricusR I'm just checking in to confirm that I've seen your PR.

I didn't get the chance to analyze it yet tho I'm afraid.

Please make sure you add tests to demonstrate what you're trying to achieve.

UlricusR commented 1 year ago

Hi @ultrabug , will add another feature and also provide the tests for both. Might take some days, though. I'll keep you posted via this PR.

UlricusR commented 1 year ago

Hi @ultrabug , the tests for both features are now added. Happy to get your feedback.

ultrabug commented 1 year ago

@UlricusR I like the idea and the README explanations really do help, thanks!

There are some tests failing and conflicts that should be resolved please.

I'd also like to ask for more comments in the added code please?

UlricusR commented 1 year ago

@ultrabug : I added some more code comments, resolved the conflicts and updated all tests to work. Happy to get your feedback.

UlricusR commented 1 year ago

You’re now added. Feel free to modify whatever you want…

UlricusR commented 1 year ago

@ultrabug , I changed the comment that the localized homepage only is relevant for the material template and also made it transparent in the README. I fear this is all I can do for now, but you should be able to modify anything that needs to be modified. Thanks for this great plugin!

ultrabug commented 1 year ago

I'm happy to announce release v1.0.0 of the mkdocs-static-i18n plugin which should help about that, thanks again @UlricusR