# MkDocs Placeholder Plugin
[](https://pypi.org/project/mkdocs-encrypt-source-plugin/)
This plugin allows you to store sensitive information in encrypted form it the source code.
When you build the site, it is decrypted using a key you pass as an enviroment variable.
This means only people with the key or access to the deployed website can access the information.
It also prevents code scanning tools from checking the data you store encrypted.
## Installation and usage
Installation and usage is described in more detail in [docs/usage.md](https://mkdocs-encrypt-source-plugin.six-two.dev/usage/).
The quick summary is:
1. Install it with pip:
```bash
mkdocs-encrypt-source-plugin
```
2. Add `encrypt-source` to the `plugins` list in `mkdocs.yml`.
3. Generate an encryption/decryption key:
```bash
echo -n | mkdocs-encrypt-source-cli -e -k "" >/dev/null
```
And export the generated key as environment variable:
```bash
export MKDOCS_ENCRYPT_SOURCE_KEY='WCFY7FJ2TlpXIG0nEqpSltXTAYB9gO3Ob6tS-psY9-s='
```
4. Encrypt all values you want to encrypt with:
```bash
echo -n "Value to encrypt" | mkdocs-encrypt-source-cli -e
```
and put the output in your Markdown source files.
5. Build the page with `mkdocs serve` and check that all encrypted values are correctly decrypted.
Raw data
{
"_id": null,
"home_page": "https://github.com/six-two/mkdocs-encrypt-source-plugin",
"name": "mkdocs-encrypt-source-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "six-two",
"author_email": "pip@six-two.dev",
"download_url": "https://files.pythonhosted.org/packages/9a/54/1fa3d9e15185a707456214181fee38817e1ab393dc9538661f92de48684c/mkdocs_encrypt_source_plugin-0.0.1.tar.gz",
"platform": null,
"description": "# MkDocs Placeholder Plugin\n\n[](https://pypi.org/project/mkdocs-encrypt-source-plugin/)\n\n\n\nThis plugin allows you to store sensitive information in encrypted form it the source code.\nWhen you build the site, it is decrypted using a key you pass as an enviroment variable.\nThis means only people with the key or access to the deployed website can access the information.\nIt also prevents code scanning tools from checking the data you store encrypted.\n\n## Installation and usage\n\nInstallation and usage is described in more detail in [docs/usage.md](https://mkdocs-encrypt-source-plugin.six-two.dev/usage/).\n\nThe quick summary is:\n\n1. Install it with pip:\n ```bash\n mkdocs-encrypt-source-plugin\n ```\n2. Add `encrypt-source` to the `plugins` list in `mkdocs.yml`.\n3. Generate an encryption/decryption key:\n ```bash\n echo -n | mkdocs-encrypt-source-cli -e -k \"\" >/dev/null\n ```\n And export the generated key as environment variable:\n ```bash\n export MKDOCS_ENCRYPT_SOURCE_KEY='WCFY7FJ2TlpXIG0nEqpSltXTAYB9gO3Ob6tS-psY9-s='\n ```\n4. Encrypt all values you want to encrypt with:\n ```bash\n echo -n \"Value to encrypt\" | mkdocs-encrypt-source-cli -e\n ```\n and put the output in your Markdown source files.\n5. Build the page with `mkdocs serve` and check that all encrypted values are correctly decrypted.\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Store some information encrypted in the source code and decrypt when building the site",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/six-two/mkdocs-encrypt-source-plugin"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f72777da7d1b1f0403b2e5ced22ac8159865c9872885690e80c1a5f91cd4396",
"md5": "6d61f981fccc76450546bab63cb8d3d2",
"sha256": "b27ee5878177481e1cd4ab4c6be6d5e038999631d9fb59516dbf9286d489f688"
},
"downloads": -1,
"filename": "mkdocs_encrypt_source_plugin-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d61f981fccc76450546bab63cb8d3d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6732,
"upload_time": "2024-08-18T14:49:13",
"upload_time_iso_8601": "2024-08-18T14:49:13.391585Z",
"url": "https://files.pythonhosted.org/packages/6f/72/777da7d1b1f0403b2e5ced22ac8159865c9872885690e80c1a5f91cd4396/mkdocs_encrypt_source_plugin-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a541fa3d9e15185a707456214181fee38817e1ab393dc9538661f92de48684c",
"md5": "9b62ba13057a65bfbabdd60ee91834e8",
"sha256": "511e58e72a5501b0aadaa8f8246d4f207798093f77ab577a0d4077d3809936e9"
},
"downloads": -1,
"filename": "mkdocs_encrypt_source_plugin-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9b62ba13057a65bfbabdd60ee91834e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5412,
"upload_time": "2024-08-18T14:49:14",
"upload_time_iso_8601": "2024-08-18T14:49:14.964204Z",
"url": "https://files.pythonhosted.org/packages/9a/54/1fa3d9e15185a707456214181fee38817e1ab393dc9538661f92de48684c/mkdocs_encrypt_source_plugin-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 14:49:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "six-two",
"github_project": "mkdocs-encrypt-source-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "mkdocs-encrypt-source-plugin"
}
JSON
