markdown-table-formatter/README.md

Format markdown tables in files

<!-- markdownlint-disable MD033 MD041 -->

# Markdown table formatter

[![Version](https://img.shields.io/npm/v/markdown-table-formatter.svg)](https://npmjs.org/package/markdown-table-formatter)
[![Downloads/week](https://img.shields.io/npm/dw/markdown-table-formatter.svg)](https://npmjs.org/package/markdown-table-formatter)
[![Downloads/total](https://img.shields.io/npm/dt/markdown-table-formatter.svg)](https://npmjs.org/package/markdown-table-formatter)
[![Mega-Linter](https://github.com/nvuillam/markdown-table-formatter/workflows/Mega-Linter/badge.svg)](https://github.com/nvuillam/mega-linter#readme)<!-- gh-dependents-info-used-by-start -->
[![Generated by github-dependents-info](https://img.shields.io/static/v1?label=Used%20by&message=24&color=informational&logo=slickpic)](https://github.com/nvuillam/markdown-table-formatter/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->
[![codecov](https://codecov.io/gh/nvuillam/markdown-table-formatter/branch/master/graph/badge.svg)](https://codecov.io/gh/nvuillam/markdown-table-formatter)
[![GitHub contributors](https://img.shields.io/github/contributors/nvuillam/markdown-table-formatter.svg)](https://gitHub.com/nvuillam/markdown-table-formatter/graphs/contributors/)
[![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?label=Star&maxAge=2592000)](https://GitHub.com/nvuillam/markdown-table-formatter/stargazers/)
[![License](https://img.shields.io/npm/l/markdown-table-formatter.svg)](https://github.com/nvuillam/markdown-table-formatter/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Format markdown tables in files, using embedded [markdown-table-prettify](https://www.npmjs.com/package/markdown-table-prettify)

[![Banner](https://raw.githubusercontent.com/nvuillam/markdown-table-formatter/master/docs/assets/images/banner.jpg)](https://github.com/nvuillam/markdown-table-formatter#readme)

## Table of contents

- [Installation](#installation)
  - [Local](#local)
  - [Global](#global)
- [Usage](#usage)
  - [Options](#options)
- [Examples](#examples)
- [Continuous Integration](#continuous-integration)
- [Ignoring Code Blocks](#ignoring-code-blocks)
- [Contribute](#contribute)
- [Release notes](#release-notes)

## Installation

### Local

```shell
npm install markdown-table-formatter --save
```

### Global

```shell
npm install markdown-table-formatter -g
```

## Usage

```shell
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

```shell
markdown-table-formatter
```

Format all markdown files found with a glob expression

```shell
markdown-table-formatter **/docs/*.md
```

Format markdown tables in a single file

```shell
markdown-table-formatter myfile.md
```

Format markdown tables in a multiple file

```shell
markdown-table-formatter myfile.md anotherFile.md andAnotherFile.md
```

Check if markdown table formatting is necessary in a single file

```shell
markdown-table-formatter --check myfile.md
```

Check if markdown table formatting is necessary in a multiple files

```shell
markdown-table-formatter --check myfile.md anotherFile.md andAnotherFile.md
```

You can see **more examples in** [**test methods**](https://github.com/nvuillam/markdown-table-formatter/blob/master/test/markdown-table-formatter.test.js)

## Continuous Integration

You can automatically check markdown tables formatting and fix it using [MegaLinter](https://github.com/oxsecurity/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](https://github.com/oxsecurity/megalinter) or [terraform-docs](https://github.com/terraform-docs/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](https://github.com/nvuillam/markdown-table-formatter/blob/master/CONTRIBUTING.md)

## Release Notes

See complete [CHANGELOG](https://github.com/nvuillam/markdown-table-formatter/blob/master/CHANGELOG.md)