Skip to main content

Extension for Python-Markdown to handle <figure> and <figcaption>.

Project description

markdown-figcap

Extension for Python-Markdown to handle <figure> and <figcaption>.

Usage

  • %%% start a <figure>
  • %: start a <figcaption>
from markdown import Markdown

text = r'''
%%%

%%% figure-class here
    ![img-alt](/source/of/img.jpg){: img-attributes here}

    %: figcaption here
    {: figcaption-attributes here}

%: will not be a figcaption
'''

md = Markdown(extensions=['markdown_figcap','attr_list'])
print(md.convert(text))

Output:

<p>%%%</p>
<figure class="figure-class here">
<img alt="img-alt" here="here" img-attributes="img-attributes" src="/source/of/img.jpg" />
<figcaption figcaption-attributes="figcaption-attributes" here="here">figcaption here</figcaption>
</figure>
<p>%: will not be a figcaption</p>

Notice

  • The attributes rendering (except <figure>'s class) is supported by the origin Python-Markdown's attr_list extension.
  • Figure starter only will not be rendered as <figure>.
  • Figcaption starter will not take effect until it is in the figure block.
  • If the <p> in <figure> has no text and only one <img> child, the <p> tag will be got rid of.

Installation

From PyPI:

pip install markdown-figcap

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

markdown-figcap-0.1.1.tar.gz (3.1 kB view hashes)

Uploaded source

Built Distribution

markdown_figcap-0.1.1-py3-none-any.whl (4.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page