Skip to main content

mkdocs-markupsafe-markdown-filter

This plugin adds pallets' MarkupSafe template filter to mkdocs.

Setup

Install the plugin using pip:

pip install mkdocs-markupsafe-markdown-filter

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - markupsafe-markdown-filter

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. This is because MkDocs enables the search plugin by default if there is no plugins entry set. When you add a external plugin like markupsafe-markdown-filter you have to enable the search plugin explicitly.

More information about plugins in the MkDocs documentation.

Usage

Enabling this plugin will filter jinja template code through a markdown filter:

{% set code_content %}
```php linenums="1"
<?php
foo = 1;
bar = 3;
if (foo == bar ) {
  // do something 
}
?>
```
{% endset %}
{{ code_content|markdown }}

See Also

More information about templates here.

More information about blocks here.

Metadata

Release files for mkdocs-markupsafe-markdown-filter 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-markupsafe-markdown-filter 0.1.1
File Size Uploaded
mkdocs_markupsafe_markdown_filter-0.1.1.tar.gz 3.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-markupsafe-markdown-filter 0.1.1
File Interpreter ABI Platform
mkdocs_markupsafe_markdown_filter-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 8.0 kB

Release files / mkdocs_markupsafe_markdown_filter-0.1.1.tar.gz

Download URL mkdocs_markupsafe_markdown_filter-0.1.1.tar.gz
Size 3.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d490d59d9f30723901c883fbd407455dd8944862c33793716c9ea0110405bf2e
BLAKE2b-256 checksum
How to use checksums
60e28b22a6d3dfa28746040b9c31fbbcea5ebd2b5543dc18bc81c91a6ecb7cc8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 8, 2025.

Transparency log

Release files / mkdocs_markupsafe_markdown_filter-0.1.1-py3-none-any.whl

Download URL mkdocs_markupsafe_markdown_filter-0.1.1-py3-none-any.whl
Size 4.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b2dfc59754309c91297bd8c32858edfb27f868ed8b8fcfd3c086f2de68389d46
BLAKE2b-256 checksum
How to use checksums
ee5042aef4e1c90a0f605c5fbb876ca3c575ea8f1a9727d9fcc3d1c3b28291f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 8, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page