JSPM

  • Created
  • Published
  • Downloads 8202
  • Score
    100M100P100Q128068F
  • License MIT

Format markdown tables in files

Package Exports

  • markdown-table-formatter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown-table-formatter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Markdown table formatter

Version Downloads/week Downloads/total Mega-Linter codecov GitHub contributors GitHub stars License PRs Welcome

Format markdown tables in files, using embedded markdown-table-prettify

Banner

Installation

Local

npm install markdown-table-formatter --save

Global

npm install markdown-table-formatter -g

Usage

markdown-table-formatter [OPTIONS] (file(s))

Options

Parameter Description Default value
-c
--check
Check only, does not update files false
-h
--help
Displays help
-v
--version
Displays version

Examples

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 Mega-Linter, that embeds markdown-table-formatter out of the box

CONTRIBUTE

Contributions are very welcome !

Please follow Contribution instructions

RELEASE NOTES

[1.0.2] 2021-01-19

  • Fix code coverage

[1.0.1] 2021-01-13

  • First working version :)

[0.0.1] 2021-01-13

  • Initial version

See complete CHANGELOG