markdown-table
Advanced tools
Package description
The markdown-table npm package is a utility for generating tables in Markdown format. It allows users to create well-formatted Markdown tables from arrays of data, providing options to customize alignment and padding.
Basic Table Creation
This feature allows the creation of a basic Markdown table from an array of arrays. Each sub-array represents a row in the table.
const markdownTable = require('markdown-table');
const table = markdownTable([
['Branch', 'Commit'],
['master', '0123456789abcdef'],
['staging', 'fedcba9876543210']
]);
console.log(table);Custom Alignment
This feature enables the specification of alignment for each column in the table. 'l' stands for left, 'c' for center, and 'r' for right.
const markdownTable = require('markdown-table');
const table = markdownTable(
[
['Feature', 'Support'],
['Tables', 'Yes'],
['Alignment', 'Yes']
],
{ align: ['l', 'c'] }
);
console.log(table);The 'table' package also allows for the creation of text-based tables, which can be used in Markdown. It offers more extensive customization options such as border styles and cell content wrapping, making it more versatile than markdown-table for complex table layouts.
Similar to 'table', cli-table3 is designed for creating Unicode-aided tables in the command line interface but can also be used to generate Markdown-compatible tables. It provides additional features like custom header styles and column width control, offering more detailed customization compared to markdown-table.
Readme
Generate fancy Markdown/ASCII tables.
npm:
npm install markdown-table
Normal usage (defaults to left-alignment):
var table = require('markdown-table')
table([
['Branch', 'Commit'],
['master', '0123456789abcdef'],
['staging', 'fedcba9876543210']
])
Yields:
| Branch | Commit |
| ------- | ---------------- |
| master | 0123456789abcdef |
| staging | fedcba9876543210 |
With alignment:
table(
[
['Beep', 'No.', 'Boop'],
['beep', '1024', 'xyz'],
['boop', '3388450', 'tuv'],
['foo', '10106', 'qrstuv'],
['bar', '45', 'lmno']
],
{
align: ['l', 'c', 'r']
}
)
Yields:
| Beep | No. | Boop |
| :--- | :-----: | -----: |
| beep | 1024 | xyz |
| boop | 3388450 | tuv |
| foo | 10106 | qrstuv |
| bar | 45 | lmno |
Alignment on dots:
table([['No.'], ['0.1.2'], ['11.22.33'], ['5.6.'], ['1.22222']], {
align: '.'
})
Yields:
| No. |
| :---------: |
| 0.1.2 |
| 11.22.33 |
| 5.6. |
| 1.22222 |
markdownTable(table[, options])Turns a given matrix of strings (an array of arrays of strings) into a table.
optionsoptions.alignOne style for all columns, or styles for their respective columns (string or
Array.<string>). Each style is either 'l' (left), 'r' (right), 'c'
(centre), or '.' (dot). Other values are treated as '', which doesn’t place
the colon but does left align. Only the lowercased first character is used,
so Right is fine.
options.delimiterValue to insert between cells (string, default: ' | '). Careful, setting
this to a non-pipe breaks GitHub Flavoured Markdown.
options.startValue to insert at the beginning of every row (string, default: '| ').
options.endValue to insert at the end of every row (string, default: ' |').
options.ruleWhether to display a rule between the header and the body of the table
(boolean, default: true). Careful, will break GitHub Flavoured Markdown
when false.
options.stringLengthMethod to detect the length of a cell (Function, default: s => s.length).
ANSI-sequences mess up tables on terminals. To fix this, you have to
pass in a stringLength option to detect the “visible” length of a
cell.
var strip = require('strip-ansi')
function stringLength(cell) {
return strip(cell).length
}
options.padWhether to pad the markdown for table cells to make them the same width
(boolean, default: true). Setting this to false will cause the table
rows to remain staggered.
The original idea and basic implementation was inspired by James Halliday’s text-table library.
FAQs
Generate a markdown (GFM) table
We found that markdown-table demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.