Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/markdown-table

markdown-table

npm versionnpm downloads Twitter Follow

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

Installation

yarn add @thi.ng/markdown-table
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/markdown-table?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/markdown-table/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 536 bytes / CJS: 582 bytes / UMD: 687 bytes

Dependencies

API

Generated API docs

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:

IDActorComment
1Alice
201Bob(foe)
3003Charlie
44Dora(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

Generated using TypeDoc