1.0.12 • Published 4 months ago

@thi.ng/markdown-table v1.0.12

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 months ago

markdown-table

npm version npm 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 import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/markdown-table"></script>

Skypack documentation

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

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

1.0.12

4 months ago

1.0.11

4 months ago

1.0.9

5 months ago

1.0.10

4 months ago

1.0.8

5 months ago

1.0.7

5 months ago

1.0.6

5 months ago

1.0.5

5 months ago

1.0.4

5 months ago

1.0.2

6 months ago

1.0.3

6 months ago

1.0.1

6 months ago

0.3.147

6 months ago

0.3.146

7 months ago

0.3.145

7 months ago

0.3.143

8 months ago

0.3.144

8 months ago

0.3.142

8 months ago

0.3.141

8 months ago

0.3.140

9 months ago

0.3.130

11 months ago

0.3.132

11 months ago

0.3.131

11 months ago

0.3.134

10 months ago

0.3.133

11 months ago

0.3.136

10 months ago

0.3.135

10 months ago

0.3.138

9 months ago

0.3.137

10 months ago

0.3.139

9 months ago

0.3.123

1 year ago

0.3.125

12 months ago

0.3.124

1 year ago

0.3.127

12 months ago

0.3.126

12 months ago

0.3.129

12 months ago

0.3.128

12 months ago

0.3.122

1 year ago

0.3.121

1 year ago

0.3.120

1 year ago

0.3.119

1 year ago

0.3.118

1 year ago

0.3.117

1 year ago

0.3.116

1 year ago

0.3.115

1 year ago

0.3.114

1 year ago

0.3.113

1 year ago

0.3.112

1 year ago

0.3.111

1 year ago

0.3.110

1 year ago

0.3.109

1 year ago

0.3.108

1 year ago

0.3.107

1 year ago

0.3.106

1 year ago

0.3.105

1 year ago

0.3.104

1 year ago

0.3.101

1 year ago

0.3.103

1 year ago

0.3.102

1 year ago

0.3.100

1 year ago

0.3.98

1 year ago

0.3.97

1 year ago

0.3.96

1 year ago

0.3.95

1 year ago

0.3.94

1 year ago

0.3.93

1 year ago

0.3.91

1 year ago

0.3.90

1 year ago

0.3.89

2 years ago

0.3.88

2 years ago

0.3.86

2 years ago

0.3.85

2 years ago

0.3.87

2 years ago

0.3.84

2 years ago

0.3.83

2 years ago

0.3.75

2 years ago

0.3.74

2 years ago

0.3.73

2 years ago

0.3.72

2 years ago

0.3.71

2 years ago

0.3.70

2 years ago

0.3.79

2 years ago

0.3.77

2 years ago

0.3.76

2 years ago

0.3.64

2 years ago

0.3.63

2 years ago

0.3.62

2 years ago

0.3.61

2 years ago

0.3.60

2 years ago

0.3.69

2 years ago

0.3.68

2 years ago

0.3.67

2 years ago

0.3.66

2 years ago

0.3.65

2 years ago

0.3.53

2 years ago

0.3.59

2 years ago

0.3.58

2 years ago

0.3.57

2 years ago

0.3.56

2 years ago

0.3.54

2 years ago

0.3.82

2 years ago

0.3.81

2 years ago

0.3.80

2 years ago

0.3.52

2 years ago

0.3.51

2 years ago

0.3.50

2 years ago

0.3.49

2 years ago

0.3.48

2 years ago

0.3.47

2 years ago

0.3.46

2 years ago

0.3.45

2 years ago

0.3.44

2 years ago

0.3.43

2 years ago

0.3.42

2 years ago

0.3.41

2 years ago

0.3.40

2 years ago

0.3.39

2 years ago

0.3.37

2 years ago

0.3.36

2 years ago

0.3.35

3 years ago

0.3.34

3 years ago

0.3.33

3 years ago

0.3.32

3 years ago

0.3.31

3 years ago

0.3.30

3 years ago

0.3.29

3 years ago

0.3.28

3 years ago

0.3.27

3 years ago

0.3.26

3 years ago

0.3.25

3 years ago

0.3.24

3 years ago

0.3.23

3 years ago

0.3.22

3 years ago

0.3.20

3 years ago

0.3.21

3 years ago

0.3.19

3 years ago

0.3.17

3 years ago

0.3.16

3 years ago

0.3.15

3 years ago

0.3.14

3 years ago

0.3.13

3 years ago

0.3.12

3 years ago

0.3.18

3 years ago

0.3.9

3 years ago

0.3.11

3 years ago

0.3.10

3 years ago

0.3.8

3 years ago

0.3.7

3 years ago

0.3.6

3 years ago

0.3.0

4 years ago

0.3.5

4 years ago

0.2.8

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.3.4

4 years ago

0.3.3

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.4

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.2.3

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago