remark-lint rule to warn when table pipes are not aligned

Usage no npm install needed!

<script type="module">
  import remarkLintTablePipeAlignment from '';



Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when table cells are inconsistently padded.


What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that table cell dividers are aligned. Tables are a GFM feature enabled with remark-gfm.


This rule is included in the following presets:

| Preset | Setting | | - | - | | remark-preset-lint-markdown-style-guide | |


This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint-table-pipe-alignment

In Deno with Skypack:

import remarkLintTablePipeAlignment from ''

In browsers with Skypack:

<script type="module">
  import remarkLintTablePipeAlignment from ''


On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintTablePipeAlignment from 'remark-lint-table-pipe-alignment'


async function main() {
  const file = await remark()
    .process(await read(''))


On the CLI:

remark --use remark-lint --use remark-lint-table-pipe-alignment

On the CLI in a config file (here a package.json):

 "remarkConfig": {
   "plugins": [
+    "remark-lint-table-pipe-alignment",


This package exports no identifiers. The default export is remarkLintTablePipeAlignment.

unified().use(remarkLintTablePipeAlignment[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

There are no options.


While aligning table dividers improves their legibility, it is somewhat hard to maintain manually, especially for tables with many rows.


remark-gfm aligns table dividers by default. Pass tablePipeAlign: false to use a more compact style.

Aligning characters is impossible because whether they look aligned or not depends on where the markup is shown: some characters (such as emoji or Chinese characters) show smaller or bigger in different places. You can pass your own stringLength to remark-gfm, in which case this rule must be turned off.


👉 Note: this example uses GFM (remark-gfm).

| A     | B     |
| ----- | ----- |
| Alpha | Bravo |

No messages.

👉 Note: this example uses GFM (remark-gfm).

| A | B |
| -- | -- |
| Alpha | Bravo |
3:9-3:10: Misaligned table fence
3:17-3:18: Misaligned table fence


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.


See in remarkjs/.github for ways to get started. See for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.


MIT © Titus Wormer