search

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

feat: make compatible with mkdocs-jupyter #172

Closed yeemh closed 1 year ago

yeemh commented 1 year ago

I opened issue #135 a few months ago and recently tried to make it compatible. (sorry for late reply)

The problem was that mkdocs doesn't read ".ipynb" and ".py" as document pages, so I added those extensions if mkdocs-jupyter is in the plugins list.

The code has been tested on this site (All Jupyter files are listed in the Tutorials index below.)

One thing left is that mkdocs-jupyter should run before mkdocs-static-i18n. I haven't figured it out yet.

You can reproduct and test with this repo.

ultrabug commented 1 year ago

Thanks @yeemh

Can you mention this behavior in the README documentation so that other users will know about this please?

yeemh commented 1 year ago

Sorry for the late reply! I'll add a description for this in the README. BTW, I found out that it won't work on the latest mkdocs versions :(, so I'll convert it to draft until I figure out how to make it run properly on the latest mkdocs too.

ultrabug commented 1 year ago

I'm happy to announce release v1.0.0 of the mkdocs-static-i18n plugin!

If you feel like contributing that to the new code base, please open a new PR! Thanks again @yeemh