Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/executablebooks/mdformat-tables
An mdformat plugin for rendering tables
https://github.com/executablebooks/mdformat-tables
markdown markdown-it mdformat pre-commit
Last synced: 3 months ago
JSON representation
An mdformat plugin for rendering tables
- Host: GitHub
- URL: https://github.com/executablebooks/mdformat-tables
- Owner: executablebooks
- License: mit
- Created: 2020-09-24T22:48:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T13:42:52.000Z (3 months ago)
- Last Synced: 2024-11-18T14:12:18.431Z (3 months ago)
- Topics: markdown, markdown-it, mdformat, pre-commit
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 11
- Watchers: 12
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdformat-tables
[![Build Status][ci-badge]][ci-link]
[![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
An [mdformat](https://github.com/executablebooks/mdformat) plugin for rendering tables.
For example, converting:
```markdown
a | b | c
:- | -: | :-:
1 | 2 | 3
xxxxxx | yyyyyy | zzzzzz
```
to:
```markdown
| a | b | c |
| :----- | -----: | :----: |
| 1 | 2 | 3 |
| xxxxxx | yyyyyy | zzzzzz |
```
For further examples, see tests/fixtures.md in the repository.
## Development
This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
To install these development dependencies:
```bash
pip install flit tox
```
To run the tests:
```bash
tox
```
To run the code formatting and style checks:
```bash
tox -e py37-pre-commit
```
or directly
```bash
pip install pre-commit
pre-commit run --all
```
To run the pre-commit hook test:
```bash
tox -e py37-hook
```
## Publish to PyPi
Either use flit directly:
```bash
flit publish
```
or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.
Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
[ci-badge]: https://github.com/executablebooks/mdformat-tables/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/executablebooks/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-tables/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/executablebooks/mdformat-tables
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-tables.svg
[pypi-link]: https://pypi.org/project/mdformat-tables