Skip to content
This repository was archived by the owner on Oct 16, 2025. It is now read-only.

Commit 8bd4129

Browse files
committed
🚀 RELEASE: v0.1.0
1 parent 5cd69d6 commit 8bd4129

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

‎README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
1-
# mdformat-tables [IN-DEVELOPMENT]
1+
# mdformat-tables
22

33
[![Build Status][ci-badge]][ci-link]
44
[![codecov.io][cov-badge]][cov-link]
55
[![PyPI version][pypi-badge]][pypi-link]
66

77
An [mdformat](https://github.com/executablebooks/mdformat) plugin for rendering tables.
88

9+
For example, converting:
10+
11+
```markdown
12+
a | b | c
13+
:- | -: | :-:
14+
1 | 2 | 3
15+
xxxxxx | yyyyyy | zzzzzz
16+
```
17+
18+
to:
19+
20+
```markdown
21+
| a | b | c |
22+
| :----- | -----: | :----: |
23+
| 1 | 2 | 3 |
24+
| xxxxxx | yyyyyy | zzzzzz |
25+
```
26+
27+
For further examples, see tests/fixtures.md in the repository.
28+
929
## Development
1030

1131
This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.

‎mdformat_tables/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
from .plugin import render_token, update_mdit # noqa: F401
44

5-
__version__ = "0.0.1"
5+
__version__ = "0.1.0"

0 commit comments

Comments
 (0)