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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file markdown-figcap-0.1.1.tar.gz.

File metadata

  • Download URL: markdown-figcap-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.2

File hashes

Hashes for markdown-figcap-0.1.1.tar.gz
Algorithm Hash digest
SHA256 61fa8a567cfad3d63754277f9d1341ada01695aafd42dd2a52c8739ce3546634
MD5 0e0ac1fdb2152ce3341177f922434360
BLAKE2b-256 d2ca2a08d8558b061aabbfcbdcac76a883589fd92a67917757b930defa915a7c

See more details on using hashes here.

File details

Details for the file markdown_figcap-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: markdown_figcap-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.2

File hashes

Hashes for markdown_figcap-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3513ba7e5afd0778fa85acf64984e2ecc881e72bfccc6e12af3c767aeaa3b4f2
MD5 784ee623ee96dfebaf8d0f680bc17386
BLAKE2b-256 43b1e704857af285a65aca4844ac50abee4a478f711f6e0b7addf4ff8e9dfeee

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