Add dynamic placeholders to your mkdocs page
Project description
MkDocs Placeholder Plugin
This plugin allows you to have placeholders in your site, that can be dynamically replaced at runtime using JavaScript (see demo page).
Documentation
This README is just a short intro to the package.
For a quick start and detailed information please see the documentation.
The documentation is also available in the docs
folder of the source code and can be built localy with MkDocs.
TODOs
- Make placeholders in Mermaid diagrams work
- What about the search entries? Can I hook into them for the normal MkDocs and the MkDocs for material plugins?
Notable changes
Version 0.1.2
- Implemented static replacements for user-selected pages
- Added timing options. This should make it possible to use with MermaidJS diagrams, but may not always work
Version 0.1.1
- Show a warning if an
input
element references a non-existent variable - Show a warning if a variable name does not match the recommended format
- Perform type checks/conversions when loading placeholder data from the data file
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-placeholder-plugin-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b691d97ea20d2a28b26d13fc0f0840a29f032901e02b78d7215a9e35750927c |
|
MD5 | 079eb30dc452471ffce6f5a879ebfd47 |
|
BLAKE2b-256 | 39647cb4eb0cfaa184521d4f3ecb3b91a2c7fb1667f00d426444b37241f7f3b8 |
Close
Hashes for mkdocs_placeholder_plugin-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b64533fe45743cf5fa004f67285f56e6df1cebf4ce1be41bfad371616cb2bcc2 |
|
MD5 | 1c47fca57e62dfac9ea3479b73d3e4c2 |
|
BLAKE2b-256 | fd69794dd72ee322b732938d60d3c6dc73eac887d8747a34ac3e1ca7e695e163 |