Skip to main content

A plugin for MkDocs that monkeypatches to support commonmark via mistletoe.

Project description

mkdocs-plugin-commonmark

A plugin for mkdocs that swaps python-markdown for mistletoe to bring CommonMark support to mkdocs. Please note, this plugin monkey-patches mkdocs as there are not plugin hooks for changing the renderer.

The majority of the code to support this plugin comes from the development Andy Pan did to fork mkdocs to add commonmark support. This plugin eliminates the need for a fork, but given that is closely coupled to mkdoc internals, it may break on a subsequent mkdoc release. It has currently been tested with version 1.1.2 of mkdocs.

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-plugin-commonmark-0.0.4.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

mkdocs_plugin_commonmark-0.0.4-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs-plugin-commonmark-0.0.4.tar.gz.

File metadata

  • Download URL: mkdocs-plugin-commonmark-0.0.4.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for mkdocs-plugin-commonmark-0.0.4.tar.gz
Algorithm Hash digest
SHA256 9034507af26646e95188a130782dd07d65c86507fddd3b47ea340c02683e85e7
MD5 ebd09adc1ad5c4325c0364027830e208
BLAKE2b-256 faa14aaa744deec61d75dbe3c67c18f6e4c1fa7699bc2661b6eff5f891e83023

See more details on using hashes here.

File details

Details for the file mkdocs_plugin_commonmark-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_plugin_commonmark-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for mkdocs_plugin_commonmark-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 70a33394d86a04ec97877ca1b2dff6181de3ec01ef4c7add178fa45b327da535
MD5 8929973f77f1466cf860cd2a69c3ba78
BLAKE2b-256 f94a4333ef1eb57ff130c7715ba0847dbdae471d153d94507004c92c591cb3c5

See more details on using hashes here.

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