Using the plugin with navigation.instant

unverbuggt / mkdocs-encryptcontent-plugin

A MkDocs plugin that encrypt/decrypt markdown content with AES

https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/

MIT License

130 stars 16 forks source link

Using the plugin with navigation.instant #18

Closed Anthares101 closed 2 years ago

Anthares101 commented 2 years ago

Hello, I noticed that when enabling the navigation.instant feature in mkdocs material theme the plugin is not working as expected:

Sometimes after using the decrypt button with the correct password the page needs to be reloaded in order to get it shown.
If the user has a cookie with the password for an article, the plugin is not able to decrypt it until the page is, once again, reloaded.

Maybe this can help because looks like the same problem: https://stackoverflow.com/questions/63145812/mkdocs-material-latex-not-rendering-in-instant-mode

Thanks for your work!

CoinK0in commented 2 years ago

Hello,

Well, I finally found the motivation to take a closer look and dig deeper into this issue :)

I learned about how js / ajax works and found a solution that solves this reload / decryption problem.

I will be pushing a version with this patch in the next few days in the Experimental branch. I still need to fix and reorder my code, it's a bit of a mess.

I would make a comeback here at that time.

CoinK0in commented 2 years ago

I publish a new major version (Version 2.0.0 Experimantal 1) of the plugin which fixes your browsing problem and adds the latest branch master fixes in addition to the search index management functionality.

It is not available on Pypi.org, you have to install it manually from source if you want to try this version.

You can then uninstall this version with :

cd ./mkdocs-encryptcontent-plugin
rm -fr build/ dist/ mkdocs_encryptcontent_plugin.egg-info/ 
pip3 uninstall mkdocs-encryptcontent-plugin -y

Any feedback you can make on this version is welcome. Thank you.

Anthares101 commented 2 years ago

Hey! I was able to test the branch and everything looks like is working. Do you know how much time you would need to move the new version to the master branch and Pypi?

Thanks for your work!

CoinK0in commented 2 years ago

I would have liked to have had more feedback but I think it would take a little while to get some and I'm pretty convinced by the code for this version after some testing, so I will probably do it next weekend. I will have to manage for the occasion the transition of certain master options which no longer exist so as not to break anything, but there should be no problem.

Thanks you for your feedback :)

Anthares101 commented 2 years ago

Perfect! I will let this open until then, people normally use the Pypi version and if they have this issue they can easily see that it will be fixed soon ^^

Thanks for your time!

Anthares101 commented 2 years ago

Hello man! I saw that you uploaded the new version to Pypi! Everything is working so I will close the issue.

Thanks!