README.md

md-condition

This is an extension to Python-Markdown which allows conditional compilations to be inserted into the text.

Install

This module can now be installed using pip.

$ pip install md-condition

Usage

The syntax for use within your Markdown files is

<!--- #if DEBUG -->
# md-condition DEBUG
<!--- #else -->
not DEBUG
<!--- #endif -->

<!--- #if RELEASE -->
# md-condition RELEASE
<!--- #else -->
not RELEASE
<!--- #endif -->

<h1>md-condition DEBUG</h1>
<p>not RELEASE</p>

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

markdown_extensions:
  - md_condition:
      symbol: DEBUG