@thi.ng/markdown-table v1.0.12
This project is part of the @thi.ng/umbrella monorepo.
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, tables with arbitrary formatting (incl. ANSI/HTML)
Installation
yarn add @thi.ng/markdown-table
ES module import:
<script type="module" src="https://cdn.skypack.dev/@thi.ng/markdown-table"></script>
For Node.js REPL:
# with flag only for < v16
node --experimental-repl-await
> const markdownTable = await import("@thi.ng/markdown-table");
Package sizes (gzipped, pre-treeshake): ESM: 633 bytes
Dependencies
API
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:
@misc{thing-markdown-table,
title = "@thi.ng/markdown-table",
author = "Karsten Schmidt",
note = "https://thi.ng/markdown-table",
year = 2021
}
License
© 2021 Karsten Schmidt // Apache Software License 2.0
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
12 months ago
11 months ago
12 months ago
11 months ago
11 months ago
10 months ago
11 months ago
10 months ago
10 months ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago