Scroll to navigation

Text::MarkdownTable(3pm) User Contributed Perl Documentation Text::MarkdownTable(3pm)

NAME

Text::MarkdownTable - Write Markdown syntax tables from data

SYNOPSIS

  my $table = Text::MarkdownTable->new;
  $table->add({one=>"a",two=>"table"});
  $table->add({one=>"is",two=>"nice"});
  $table->done;
  | one | two   |
  |-----|-------|
  | a   | table |
  | is  | nice  |
  Text::MarkdownTable->new( columns => ['X','Y','Z'], edges => 0 )
    ->add({a=>1,b=>2,c=>3})->done;
  X | Y | Z
  --|---|--
  1 | 2 | 3

DESCRIPTION

This module can be used to write data in tabular form, formatted in MultiMarkdown syntax. The resulting format can be used for instance to display CSV data or to include data tables in Markdown files. Newlines and vertical bars in table cells are replaced by a space character and cell values can be truncated.

CONFIGURATION

Filename, GLOB, scalar reference or IO::Handle to write to (default STDOUT).
Array, hash reference, or comma-separated list of fields/columns.
Column names. By default field names are used.
Column widths. By default column widths are calculated automatically to the width of the widest value. With given widths, the table is directly be written without buffering and large table cell values are truncated.
Include header lines. Enabled by default.
Include border before first column and after last column. Enabled by default. Note that single-column tables don't not look like tables if edges are disabled.
Write table unbuffered in condense format: 

  one|two
  ---|---
  a|table
  is|nice

Note that single-column tables are don't look like tables on condense format.

METHODS

Add a row as hash reference. Returns the table instance.
Returns whether rows are directly written or buffered until "done" is called.
Finish and write the table unless it has already been written in "streaming" mode.

SEE ALSO

See Catmandu::Exporter::Table for an application of this module that can be used to easily convert data to Markdown tables.

Similar table-generating modules include:

AUTHOR

Jakob Voss <jakob.voss@gbv.de>

COPYRIGHT AND LICENSE

Copyright 2014- Jakob Voss

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2023-02-04 perl v5.36.0