Skip to main content

A Python-Markdown extension to ignore html comments opened by three dashes.

Project description


Original plugin was created by ryneeverett.

A Python-Markdown preprocessor extension to ignore html comments opened by three dashes and any whitespace prior to them. I believe pandoc has similar functionality.

<!-- This is a standard html comment which will remain in the output. -->
<!--- This is a markdown comment which this extension removes. -->


pip install python-markdown-comments


>>> import markdown
>>> from python_markdown_comments import CommentsExtension
>>> comments = CommentsExtension()
>>> markdowner = markdown.Markdown(extensions=[comments])
>>> markdowner.convert("""\
... blah blah blah  <!--- inline comment -->
... <!---multiline comment
... multiline comment
... multiline comment-->
... even more text.""")
u'<p>blah blah blah</p>\n<p>even more text.</p>'

Infrequently Asked Questions

How can I write about markdown comments without them being removed?

In order to render markdown comments, you must *(a)*use them in an html block (which are not processed as markdown) and *(b)*escape the brackets so the browser won't think they're html comments. E.g.:

&lt;!--- meta markdown comment --&gt;

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

python-markdown-comments-1.1.0.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

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