Metadata-Version: 2.1
Name: mdx-spanner
Version: 0.0.2
Summary: Span table cols and rows in MkDocs
Home-page: https://gitlab.com/mschleeweiss/mdx_spanner
Author: Marc Schleeweiß
Author-email: mschleeweiss@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://gitlab.com/mschleeweiss/mdx_spanner/-/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# mdx_spanner

This package enables `rowspan` and `colspan` in markdown tables when using [MkDocs](https://www.mkdocs.org/).

## Syntax

You can activate `colspan` by putting only `~~` in a cell. This will merge the cell with the cell in the previous column.

You can activate `rowspan` by putting `__` in a cell. This will merge the cell with the cell in the previous row. If the cell in previous row is empty it will continue to merge until it finds a non-empty cell.

Sample:

```md
| Header 1 | Header 2 | Header 3 |
| ---------| -------- | -------- |
| Value 1  |    ~~    | Value 2  |
|          |    ~~    | Value 3  |
|_        _|    ~~    | Value 5  |
| Value 6  | Value 7  | Value 8  |
```

This should result in the following table:
```md
+----------+----------+----------+
| Header 1 | Header 2 | Header 3 |
+----------+----------+----------+
| Value 1             | Value 2  |
|                     +----------+
|                     | Value 3  |
|                     +----------+
|                     | Value 5  |
+----------+----------+----------+
| Value 6  | Value 7  | Value 8  |
+----------+----------+----------+
```

## Install

```console
$ pip install mdx_spanner
```

