Awesome
<!-- markdownlint-disable MD033 MD041 -->Markdown table formatter
<!-- gh-dependents-info-used-by-start -->
Format markdown tables in files, using embedded markdown-table-prettify
Table of contents
Installation
Local
npm install markdown-table-formatter --save
Global
npm install markdown-table-formatter -g
Usage
markdown-table-formatter [OPTIONS] (file(s) or glob expression)
Options
| Parameter | Description | Default value |
|---|---|---|
| -c<br/>--check | Check only, does not update files | false |
| -p<br/>--columnpadding | Override column padding number of spaces | |
| -h<br/>--help | Displays help | <!-- --> |
| -v<br/>--version | Displays version | <!-- --> |
Examples
Format all markdown files found within current directory
markdown-table-formatter
Format all markdown files found with a glob expression
markdown-table-formatter **/docs/*.md
Format markdown tables in a single file
markdown-table-formatter myfile.md
Format markdown tables in a multiple file
markdown-table-formatter myfile.md anotherFile.md andAnotherFile.md
Check if markdown table formatting is necessary in a single file
markdown-table-formatter --check myfile.md
Check if markdown table formatting is necessary in a multiple files
markdown-table-formatter --check myfile.md anotherFile.md andAnotherFile.md
You can see more examples in test methods
Continuous Integration
You can automatically check markdown tables formatting and fix it using MegaLinter, that embeds markdown-table-formatter out of the box
Ignoring Code Blocks
You may wish to ignore specific markdown content, especially when using with Megalinter or terraform-docs
To achieve this, place tags <!-- markdown-table-prettify-ignore-start --> and <!-- markdown-table-prettify-ignore-end --> around the content you want markdown-table-formatter to ignore.
Contribute
Contributions are very welcome !
Please follow Contribution instructions
Release Notes
See complete CHANGELOG