Skip to main content

Add dynamic placeholders to your mkdocs page

Project description

MkDocs Placeholder Plugin

PyPI version License Python versions

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-placeholder-plugin-0.1.2.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_placeholder_plugin-0.1.2-py3-none-any.whl (10.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page