!@thi.ng/markdown-table

!npm downloads

> [!NOTE]
> This is one of 214 standalone projects, maintained as part
> of the @thi.ng/umbrella monorepo
> and anti-framework.
>
> 🚀 Please help me to work full-time on these projects by sponsoring me on
> GitHub. Thank you! ❤️

- About
- Status
- Related packages
- Installation
- Dependencies
- API
- Authors
- License

About

Markdown table formatter/generator with support for column alignments.

See related packages below for alternative solutions / approaches...

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

- @thi.ng/hiccup-markdown - Markdown parser & serializer from/to Hiccup format
- @thi.ng/text-canvas - Text based canvas, drawing, plotting, tables with arbitrary formatting (incl. ANSI/HTML)

Installation

``bash
yarn add @thi.ng/markdown-table
`

ESM import:

`ts
import * as mt from "@thi.ng/markdown-table";
`

Browser ESM import:

`html

`

JSDelivr documentation

For Node.js REPL:

`js
const mt = await import("@thi.ng/markdown-table");
`

Package sizes (brotli'd, pre-treeshake): ESM: 617 bytes

Dependencies

- @thi.ng/api
- @thi.ng/checks
- @thi.ng/compose
- @thi.ng/errors
- @thi.ng/strings
- @thi.ng/transducers

Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)

API

Generated API docs

`ts
import { table, tableKeys } from "@thi.ng/markdown-table";

table(
["ID", "Actor", "Comment"],
[
[1, "Alice"],
[201, "Bob", "(foe)"],
[3003, "Charlie", null],
[44, "Dora", "(recipient)"],
],
{ align: ["r", "c", "l"] }
);

// | ID | Actor | Comment |
// |-------:|:---------:|:------------|
// | 1 | Alice | |
// | 201 | Bob | (foe) |
// | 3003 | Charlie | |
// | 44 | Dora | (recipient) |

// ...alternatively, this produces the same:

tableKeys(
// column headers
["ID", "Actor", "Comment"],
// lookup keys
["id", "name", "hint"],
// rows as objects
[
{ id: 1, name: "Alice" },
{ id: 201, name: "Bob", hint: "(foe)" },
{ id: 3003, name: "Charlie" },
{ id: 44, name: "Dora", hint: "(recipient)" },
],
// table options
{ bold: true, align: ["r", "c", "l"] }
)
`

Result as Markdown:

| ID | Actor | Comment |
|-------:|:---------:|:------------|
| 1 | Alice | |
| 201 | Bob | (foe) |
| 3003 | Charlie | |
| 44 | Dora | (recipient) |

Authors

- Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

`bibtex
@misc{thing-markdown-table,
title = "@thi.ng/markdown-table",
author = "Karsten Schmidt",
note = "https://thi.ng/markdown-table",
year = 2021
}
``

License

© 2021 - 2026 Karsten Schmidt // Apache License 2.0