Skip to main content

A Python-Markdown extension to render grid tables

Project description

Markdown grid table extension

PyPI - Version PyPI - Python Version

A Python-Markdown extension to render grid tables.

Example:

+-------------------+------------------+----------------+
| Header 1          | Header 2         | Header 3       |
+===================+==================+================+
| Cells can span multiple columns      | Cells can span |
+--------------------------------------+ multiple rows  |
| Text in cells *can be* **formatted** |                |
|                                      |                |
| > and can contain arbitrary          |                |
| > multi-line blocks                  |                |
+--------------------------------------+----------------+

Installation

pip install markdown-grids

Usage

import markdown
text = ...  # your Markdown source
html = markdown.markdown(text, extensions='grids')

To use with MkDocs, add the following to mkdocs.yml:

markdown_extensions:
  - grids

Because whitespace in a grid table is structural, it is not possible to indicate a newline in a cell with two spaces at the end of the line. Two possible solutions to this are:

Licence

markdown-grids is distributed under the terms of the MIT licence.

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_grids-1.0.0.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

markdown_grids-1.0.0-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

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