markdown-table-formatter

    1.3.0 • Public • Published

    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) or glob expression)

    Options

    Parameter Description Default value
    -c
    --check
    Check only, does not update files false
    -p
    --columnpadding
    Override column padding number of spaces
    -h
    --help
    Displays help
    -v
    --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 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

    Install

    npm i markdown-table-formatter

    DownloadsWeekly Downloads

    633

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    13.8 kB

    Total Files

    8

    Last publish

    Collaborators

    • nvuillam