|
1 | | -# mkdocs-encryptcontent-plugin |
2 | | - |
3 | | -# Table of Contents |
4 | | - * [Todos for 3.0.x](#Todos-for-3.0.x) |
5 | | - * [Todos for 3.1.x](#Todos-for-3.1.x) |
6 | | -* [Installation](#Installation) |
7 | | -* [Usage](#Usage) |
8 | | - * [Global password protection](#Global-password-protection) |
9 | | - * [Password inventory](#Password-inventory) |
10 | | - * [Secret from environment](#Secret-from-environment) |
11 | | - * [Default vars customization](#Default-vars-customization) |
12 | | - * [Translations](#Translations) |
13 | | - * [Obfuscate pages](#Obfuscate-pages) |
14 | | - * [Example plugin configuration](#Example-plugin-configuration) |
15 | | -* [Features](#Features) |
16 | | - * [Override default templates](#Override-default-templates) |
17 | | - * [Add button](#Add-button) |
18 | | - * [Tag encrypted page](#Tag-encrypted-page) |
19 | | - * [Remember password](#Remember-password) |
20 | | - * [Modify generated pages](#Modify-generated-pages) |
21 | | - * [Encrypt something](#Encrypt-something) |
22 | | - * [Inject decrypt-form.tpl to theme](#Inject-decrypt-form.tpl-to-theme) |
23 | | - * [Mix encrypted and normal content](#Mix-encrypted-and-normal-content) |
24 | | - * [Search encryption](#Search-encryption) |
25 | | - * [Search index encryption](#Search-index-encryption) |
26 | | - * [Search index encryption for mkdocs-material](#Search-index-encryption-for-mkdocs-material) |
27 | | - * [Javascript extensions](#Javascript-extensions) |
28 | | - * [Reload user-defined scripts](#Reload-user-defined-scripts) |
29 | | - * [HighlightJS support](#HighlightJS-support) |
30 | | - * [Arithmatex support](#Arithmatex-support) |
31 | | - * [Mermaid2 support](#Mermaid2-support) |
32 | | - * [Security](#Security) |
33 | | - * [Crypto-js or webcrypto?](#Crypto-js-or-webcrypto?) |
34 | | - * [File name obfuscation](#File-name-obfuscation) |
35 | | - * [Signing of generated files](#Signing-of-generated-files) |
36 | | - |
37 | | - |
38 | 1 | [![PyPI Version][pypi-v-image]][pypi-v-link] |
39 | 2 | [](https://pypi.org/project/mkdocs-encryptcontent-plugin) |
40 | 3 | [](https://opensource.org/licenses/MIT)' |
41 | 4 |
|
| 5 | +# mkdocs-encryptcontent-plugin |
| 6 | + |
42 | 7 | This plugin allows you to have password protected articles and pages in MKdocs. |
43 | 8 |
|
44 | 9 | The content is encrypted with AES-256 in Python using PyCryptodome and decrypted in the browser with Crypto-JS or Webcrypto. |
@@ -76,6 +41,41 @@ The content is encrypted with AES-256 in Python using PyCryptodome and decrypted |
76 | 41 | ## Todos for 3.1.x |
77 | 42 | * optional server side keystore (allows throtteling) |
78 | 43 | * ...to be defined |
| 44 | + |
| 45 | + |
| 46 | +# Table of Contents |
| 47 | +* [Installation](#Installation) |
| 48 | +* [Usage](#Usage) |
| 49 | + * [Global password protection](#Global-password-protection) |
| 50 | + * [Password inventory](#Password-inventory) |
| 51 | + * [Secret from environment](#Secret-from-environment) |
| 52 | + * [Default vars customization](#Default-vars-customization) |
| 53 | + * [Translations](#Translations) |
| 54 | + * [Obfuscate pages](#Obfuscate-pages) |
| 55 | + * [Example plugin configuration](#Example-plugin-configuration) |
| 56 | +* [Features](#Features) |
| 57 | + * [Override default templates](#Override-default-templates) |
| 58 | + * [Add button](#Add-button) |
| 59 | + * [Tag encrypted page](#Tag-encrypted-page) |
| 60 | + * [Remember password](#Remember-password) |
| 61 | + * [Modify generated pages](#Modify-generated-pages) |
| 62 | + * [Encrypt something](#Encrypt-something) |
| 63 | + * [Inject decrypt-form.tpl to theme](#Inject-decrypt-form.tpl-to-theme) |
| 64 | + * [Mix encrypted and normal content](#Mix-encrypted-and-normal-content) |
| 65 | + * [Search encryption](#Search-encryption) |
| 66 | + * [Search index encryption](#Search-index-encryption) |
| 67 | + * [Search index encryption for mkdocs-material](#Search-index-encryption-for-mkdocs-material) |
| 68 | + * [Javascript extensions](#Javascript-extensions) |
| 69 | + * [Reload user-defined scripts](#Reload-user-defined-scripts) |
| 70 | + * [HighlightJS support](#HighlightJS-support) |
| 71 | + * [Arithmatex support](#Arithmatex-support) |
| 72 | + * [Mermaid2 support](#Mermaid2-support) |
| 73 | + * [Security](#Security) |
| 74 | + * [Crypto-js or webcrypto?](#Crypto-js-or-webcrypto?) |
| 75 | + * [File name obfuscation](#File-name-obfuscation) |
| 76 | + * [Signing of generated files](#Signing-of-generated-files) |
| 77 | + |
| 78 | + |
79 | 79 | # Installation |
80 | 80 |
|
81 | 81 | Install the package with pip: |
|
0 commit comments