Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

markdown-table-formatter

Package Overview
Dependencies
Maintainers
1
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

markdown-table-formatter

Format markdown tables in files

  • 1.6.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.4K
decreased by-26.79%
Maintainers
1
Weekly downloads
 
Created
Source

Markdown table formatter

Version Downloads/week Downloads/total Mega-Linter Generated by github-dependents-info codecov GitHub contributors GitHub stars License PRs Welcome

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

Banner

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

ParameterDescriptionDefault value
-c
--check
Check only, does not update filesfalse
-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 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

Keywords

FAQs

Package last updated on 10 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc