micromark-extension-pipe-table

A micromark syntax extension that adds support for a custom pipe-based table syntax.

This package provides syntax only and is intended to be used with remark or other unified pipelines.

Vertical Cell Syntax

Pipe Table allows table cells to be written vertically, one per line, instead of being confined to a single row.

| a
    | b
    | c

This represents one table row with three cells.

Vertical layout makes tables easier to edit, reorder, and review in diffs, and enables multi-line and block-level content inside cells.

For the complete syntax specification, see: docs/syntax.md

Install

npm install micromark-extension-pipe-table

Usage

import { micromark } from 'micromark'
import { pipeTable, pipeTableHtml } from 'micromark-extension-pipe-table'

const html = micromark('| a | b | c', {
    extensions: [pipeTable()],
    htmlExtensions: [pipeTableHtml()]
})
console.log(html)

Options

pipeTableHtml({
  /**
   * Alignment class prefix.
   * default: "cell-"
   */
  classPrefix?: string

  /**
   * Use logical alignment classes (start / center / end)
   * default: false
   */
  useLogicalAlignment?: boolean
})

• Alignment classes are applied to <td> only:
  • cell-left
  • cell-center
  • cell-right

Notes

• Lines starting with | (optionally preceded by up to 3 spaces) are treated as table rows.
• Escaped pipes (\|) are preserved as literal text.
• This extension works with micromark alone.
  If you want to convert pipe-table syntax into mdast or hast, use it together with the following packages:
  • mdast-util-pipe-table
  • hast-util-pipe-table

Related Packages

• mdast-util-pipe-table Converts pipe-table tokens into mdast nodes and defines the canonical AST shape.
• hast-util-pipe-table Transforms pipe-table mdast nodes into HTML (hast).
• remark-pipe-table Remark plugin that wires all pipe-table extensions together.

License

MIT