markdown-grids


Namemarkdown-grids JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryA Python-Markdown extension to render grid tables
upload_time2023-12-02 22:17:31
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Markdown grid table extension

[![PyPI - Version](https://img.shields.io/pypi/v/markdown-grids.svg)](https://pypi.org/project/markdown-grids)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/markdown-grids.svg)](https://pypi.org/project/markdown-grids)

A [Python-Markdown](https://python-markdown.github.io/) 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

```console
pip install markdown-grids
```

## Usage

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

To use with [MkDocs](https://www.mkdocs.org/), add the following to `mkdocs.yml`:
```yaml
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:
- The [New-Line-to-Break extension](https://python-markdown.github.io/extensions/nl2br/)
- The [Markdown line block extension](https://github.com/mjayfrancis/markdown-grids)


## Licence

`markdown-grids` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) licence.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "markdown-grids",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Matthew Francis <mjay.francis@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f6/a6/87e316f09cb4044214e5ea34b4d6421e41fb3e90bab2a1ecf2137b5a8072/markdown_grids-1.0.0.tar.gz",
    "platform": null,
    "description": "# Markdown grid table extension\n\n[![PyPI - Version](https://img.shields.io/pypi/v/markdown-grids.svg)](https://pypi.org/project/markdown-grids)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/markdown-grids.svg)](https://pypi.org/project/markdown-grids)\n\nA [Python-Markdown](https://python-markdown.github.io/) extension to render grid tables.\n\nExample:\n```\n+-------------------+------------------+----------------+\n| Header 1          | Header 2         | Header 3       |\n+===================+==================+================+\n| Cells can span multiple columns      | Cells can span |\n+--------------------------------------+ multiple rows  |\n| Text in cells *can be* **formatted** |                |\n|                                      |                |\n| > and can contain arbitrary          |                |\n| > multi-line blocks                  |                |\n+--------------------------------------+----------------+\n```\n\n\n-----\n\n## Installation\n\n```console\npip install markdown-grids\n```\n\n## Usage\n\n```py\nimport markdown\ntext = ...  # your Markdown source\nhtml = markdown.markdown(text, extensions='grids')\n```\n\nTo use with [MkDocs](https://www.mkdocs.org/), add the following to `mkdocs.yml`:\n```yaml\nmarkdown_extensions:\n  - grids\n```\n\nBecause whitespace in a grid table is structural, it is not possible to indicate a newline in a\ncell with two spaces at the end of the line.\nTwo possible solutions to this are:\n- The [New-Line-to-Break extension](https://python-markdown.github.io/extensions/nl2br/)\n- The [Markdown line block extension](https://github.com/mjayfrancis/markdown-grids)\n\n\n## Licence\n\n`markdown-grids` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) licence.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python-Markdown extension to render grid tables",
    "version": "1.0.0",
    "project_urls": {
        "Documentation": "https://github.com/mjayfrancis/markdown-grids#readme",
        "Issues": "https://github.com/mjayfrancis/markdown-grids/issues",
        "Source": "https://github.com/mjayfrancis/markdown-grids"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ba5cd81385c1d24fa73ad9d409505d814dbcaeec233c4a5a9fd5ed45e3d422a5",
                "md5": "5889401de9804a31e7e77e4443ebb8d6",
                "sha256": "f45dad17006eab6f9a3f282091cae522a90dc773838f4aea255ca66b73333227"
            },
            "downloads": -1,
            "filename": "markdown_grids-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5889401de9804a31e7e77e4443ebb8d6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5870,
            "upload_time": "2023-12-02T22:17:33",
            "upload_time_iso_8601": "2023-12-02T22:17:33.366389Z",
            "url": "https://files.pythonhosted.org/packages/ba/5c/d81385c1d24fa73ad9d409505d814dbcaeec233c4a5a9fd5ed45e3d422a5/markdown_grids-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f6a687e316f09cb4044214e5ea34b4d6421e41fb3e90bab2a1ecf2137b5a8072",
                "md5": "0dc856d46875d95ae8319168419aa61d",
                "sha256": "bd1d8472649d528348fc91ff58fbbd68b2d0b0e09a6f3ab154cdd786eaf661e3"
            },
            "downloads": -1,
            "filename": "markdown_grids-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0dc856d46875d95ae8319168419aa61d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5295,
            "upload_time": "2023-12-02T22:17:31",
            "upload_time_iso_8601": "2023-12-02T22:17:31.563853Z",
            "url": "https://files.pythonhosted.org/packages/f6/a6/87e316f09cb4044214e5ea34b4d6421e41fb3e90bab2a1ecf2137b5a8072/markdown_grids-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-02 22:17:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mjayfrancis",
    "github_project": "markdown-grids#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "markdown-grids"
}
        
Elapsed time: 0.19315s