About markdown table formatter
Tidy an untidy Markdown table so every column lines up. The result is easier to read in plain text and produces cleaner diffs.
Alignment
Use :--- for left, ---: for right and :---: for centred columns in the separator row.
A worked example
A table where the columns have uneven widths is rewritten so every pipe lines up, with padding added to short cells. The rendered table is identical, but the raw text is much easier to read and review in a pull request.
Alignment
- Left: :---
- Centre: :---:
- Right: ---:
A worked example
A table with a short first column and a long second column is padded so that the pipes align in plain text. Only whitespace changes, so the rendered table looks exactly the same as before.
Editor support
- Many editors can format tables automatically, such as with a Markdown extension.
- Format tables before committing, so the diffs show real changes only.
- Escape pipe characters inside cells.
