Version 2.2.1

Author: CoinK0in

.gitignore

@@ -1,5 +1,9 @@
 # mkdocs-encryptcontent-plugin
 
+[![PyPI Version][pypi-v-image]][pypi-v-link]
+[![PyPI downloads](https://img.shields.io/pypi/dm/mkdocs-encryptcontent-plugin.svg)](https://pypi.org/project/mkdocs-encryptcontent-plugin)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 
+
 This plugin allows you to have password protected articles and pages in MKdocs.
 
 The content is encrypted with AES-256 in Python using PyCryptodome, and decrypted in the browser with Crypto-JS.
@@ -18,6 +22,8 @@ The content is encrypted with AES-256 in Python using PyCryptodome, and decrypte
 >
 > If a password is defined as an empty character string, the content is not protected.
 
+![encryptcontent_demo](https://user-images.githubusercontent.com/12155947/177001700-f0920d4b-0c41-4d11-8164-9f63d29d8a6a.gif)
+
 
 # Table of Contents
 
@@ -52,7 +58,7 @@ Install the package from source with pip:
 ```bash
 cd mkdocs-encryptcontent-plugin/
 python3 setup.py sdist bdist_wheel
-pip3 install dist/mkdocs_encryptcontent_plugin-2.2.0-py3-none-any.whl
+pip3 install dist/mkdocs_encryptcontent_plugin-2.2.1-py3-none-any.whl
 ```
 
 Enable the plugin in your `mkdocs.yml`:
@@ -212,19 +218,6 @@ For example, in your theme template, you can use conditional check to add custom
 <a {% if nav_item.encrypted %}class="mkdocs-encrypted-class"{% endif %}href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
 ```
 
-### Add button
-
-Add `password_button: True` in plugin config variable, to add button to the right of the password field decrypt the content.
-
-Optionnally, you can add `password_button_text: 'custome_text_button'` to customize the button text.
- 
-```yaml
-plugins:
-    - encryptcontent:
-        password_button: True
-        password_button_text: 'custome_text_button'
-```
-
 ### Rebember password
 
 Related to [issue #6](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/6)
@@ -425,3 +418,7 @@ If you want to contribute to the code of this project, please read the [Contribu
 [mkdocs-plugins]: https://www.mkdocs.org/dev-guide/plugins/
 [github-issues]: https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues
 [contributing]: CONTRIBUTING.md
+
+<!-- Badges -->
+[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-encryptcontent-plugin.svg
+[pypi-v-link]: https://pypi.org/project/mkdocs-encryptcontent-plugin/

README.md

@@ -23,8 +23,15 @@ function joinUrl (base, path) {
   return base + "/" + path;
 }
 
+function escapeHtml (value) {
+  return value.replace(/&/g, '&')
+    .replace(/"/g, '"')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;');
+}
+
 function formatResult (location, title, summary) {
-  return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ title + '</a></h3><p>' + summary +'</p></article>';
+  return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
 }
 
 function displayResults (results) {

encryptcontent/contrib/templates/search/main.js

@@ -220,7 +220,6 @@ def on_pre_build(self, config, **kwargs):
         try:
             if self.config['search_index'] in ['encrypted', 'dynamically']:
                 from mkdocs.contrib.search.search_index import SearchIndex, ContentParser
-
                 def _create_entry_for_section(self, section, toc, abs_url, password=None):
                     toc_item, text = self._find_toc_by_id(toc, section.id), ''
                     if not self.config.get('indexing') or self.config['indexing'] == 'full':
@@ -232,25 +231,20 @@ def _create_entry_for_section(self, section, toc, abs_url, password=None):
                     if toc_item is not None:
                         self._add_entry(title=toc_item.title, text=text, loc=abs_url + toc_item.url)
                 SearchIndex.create_entry_for_section = _create_entry_for_section
-
                 def _add_entry_from_context(self, page):
                     parser, url, text = ContentParser(), page.url, ''
                     parser.feed(page.content)
                     parser.close()
                     if not self.config.get('indexing') or self.config['indexing'] == 'full':
                         text = parser.stripped_html.rstrip('\n')
-                    if (hasattr(page, 'encrypted') and hasattr(page, 'password')
-                            and page.password is not None):                             # noqa: W503
+                    if (hasattr(page, 'encrypted') and hasattr(page, 'password') and page.password is not None):
                         plugin = config['plugins']['encryptcontent']
                         code = plugin.__encrypt_text_aes__(text, str(page.password))
                         text = b';'.join(code).decode('ascii')
                     self._add_entry(title=page.title, text=text, loc=url)
-                    if (self.config.get('indexing')
-                            and self.config['indexing'] in ['full', 'sections']):       # noqa: W503
+                    if (self.config.get('indexing') and self.config['indexing'] in ['full', 'sections']):
                         for section in parser.data:
-                            if (hasattr(page, 'encrypted')
-                                    and hasattr(page, 'password')                       # noqa: W503
-                                        and page.password is not None):                 # noqa: W503, E127
+                            if (hasattr(page, 'encrypted') and hasattr(page, 'password') and page.password is not None):
                                 self.create_entry_for_section(section, page.toc, url, page.password)
                             else:
                                 self.create_entry_for_section(section, page.toc, url)

encryptcontent/plugin.py

@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name='mkdocs-encryptcontent-plugin',
-    version='2.2.0',
+    version='2.2.1',
     author='CoinK0in',
     author_email='[email protected]',
     description='A MkDocs plugin that encrypt/decrypt markdown content with AES',