Skip to content

Commit 5306828

Browse files
committed
Entering LTS - Version number tracking
1 parent 14bc93d commit 5306828

File tree

2 files changed

+16
-24
lines changed

2 files changed

+16
-24
lines changed

README.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
*It has been tested in Python Python 3.5+*
88

9-
An mkdocs version of the plugin [Encrypt content](https://github.com/mindcruzer/pelican-encrypt-content) for Pelican.
10-
119
**Usecase**
1210

1311
> I want to be able to protect my articles with password. And I would like this protection to be as granular as possible.
@@ -34,7 +32,7 @@ Install the package from source with pip:
3432
```bash
3533
cd mkdocs-encryptcontent-plugin/
3634
python3 setup.py sdist bdist_wheel
37-
pip3 install dist/mkdocs_encryptcontent_plugin-0.0.13-py3-none-any.whl
35+
pip3 install dist/mkdocs_encryptcontent_plugin-1.0.0-py3-none-any.whl
3836
```
3937

4038
Enable the plugin in your `mkdocs.yml`:
@@ -106,6 +104,20 @@ document.getElementById("mkdocs-decrypted-content").querySelectorAll('pre code')
106104
{% endif %}
107105
```
108106

107+
### Arithmatex support
108+
109+
Related to [issue #12](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/12)
110+
111+
If Arithmatex markdown extension is set in your markdown extensions to improve math equations rendering, reload rendering after decryption process.
112+
113+
When enable the following part of the template is add to force math equations rendering on decrypted content.
114+
115+
```jinja
116+
{% if arithmatex %}MathJax.typesetPromise(){% endif %}
117+
```
118+
119+
> **NOTE** It has been tested in Arithmatex `generic` mode only.
120+
109121
### Tag encrypted page
110122

111123
Related to [issue #7](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/7)
@@ -189,8 +201,6 @@ plugins:
189201
```
190202
191203
192-
## [:wrench: BETA] Features
193-
194204
### Encrypt Something
195205
196206
Related to [issue #9](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/9)
@@ -271,24 +281,6 @@ Your configuration like this :
271281
mkdocs-encrypted-footer-meta: [div, id]
272282
```
273283

274-
:gear: This feature is still in beta, all feedback, improvement, fixes, are welcome.
275-
276-
### Arithmatex support
277-
278-
Related to [issue #12](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/12)
279-
280-
If Arithmatex markdown extension is set in your markdown extensions to improve math equations rendering, reload rendering after decryption process.
281-
282-
When enable the following part of the template is add to force math equations rendering on decrypted content.
283-
284-
```jinja
285-
{% if arithmatex %}MathJax.typesetPromise(){% endif %}
286-
```
287-
288-
> **NOTE** It has been tested in Arithmatex `generic` mode only.
289-
290-
:gear: This feature is still in beta, all feedback, improvement, fixes, are welcome.
291-
292284

293285
## Contributing
294286

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def read(fname):
1111

1212
setup(
1313
name='mkdocs-encryptcontent-plugin',
14-
version='0.0.13',
14+
version='1.0.0',
1515
author='CoinK0in',
1616
author_email='[email protected]',
1717
description='A MkDocs plugin that encrypt/decrypt markdown content with AES',

0 commit comments

Comments
 (0)