vexy-mkdocs-markdown-in-template
Documentation: https://vexy.dev/vexy-mkdocs-markdown-in-template/
Write Markdown inside your MkDocs theme's Jinja2 templates.
Theme partials are HTML; your content is Markdown. This plugin lets you write
Markdown right in a template, wrapped in {% md %} ... {% mdend %}, and renders it
to HTML while the page builds. The block uses your site's own markdown_extensions
and mdx_configs, so tables, footnotes, and admonitions behave exactly as they do
in a page body.
Installation
pip install vexy-mkdocs-markdown-in-template
Configuration
In mkdocs.yml, list the plugin as early as possible so later plugins see the
rendered HTML:
plugins:
- markdown-in-template
Usage
In any HTML template partial, wrap Markdown in {% md %} and {% mdend %}:
<article>
{% md %}
# Heading
Regular and **bold** text
{% mdend %}
</article>
The plugin strips the block's common leading indentation, using the first non-blank line as the baseline — so you can indent Markdown to line up with the surrounding HTML without it being read as a code block.
Development
pip install -e .[dev]
pytest # unit + full mkdocs-build integration test
ruff check . # lint
mypy # type check
Documentation
Full docs: https://vexy.dev/vexy-mkdocs-markdown-in-template/
License
MIT — see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for vexy-mkdocs-markdown-in-template 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vexy_mkdocs_markdown_in_template-1.0.6.tar.gz | 6.4 kB | Without provenance | Details for vexy_mkdocs_markdown_in_template-1.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vexy_mkdocs_markdown_in_template-1.0.6-py3-none-any.whl | Python 3 | none | any | Details for vexy_mkdocs_markdown_in_template-1.0.6-py3-none-any.whl |
Total release size: 12.4 kB
Release files / vexy_mkdocs_markdown_in_template-1.0.6.tar.gz
| Download URL | vexy_mkdocs_markdown_in_template-1.0.6.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f83e8a79f409c9a6d78646d436692ba93ab2f11ec3a2963036087909cb81094
|
|
BLAKE2b-256 checksum How to use checksums |
f06276cfd778722e50e1e55a801aa83d59316e9bd5303e07f8110b95b9d8dac6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / vexy_mkdocs_markdown_in_template-1.0.6-py3-none-any.whl
| Download URL | vexy_mkdocs_markdown_in_template-1.0.6-py3-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a32deb6db954f92a2e1b6fc21c9f7d9188a07289f8858b9680fd7991fc126ea4
|
|
BLAKE2b-256 checksum How to use checksums |
ced1e6ad5a18079ab2acaffbb3e4ab0d248147c5f771e0af6adfdc360cd0e9f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for vexy-mkdocs-markdown-in-template 1.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
