Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nichtich/text-markdowntable
Write Markdown syntax tables
https://github.com/nichtich/text-markdowntable
Last synced: 8 days ago
JSON representation
Write Markdown syntax tables
- Host: GitHub
- URL: https://github.com/nichtich/text-markdowntable
- Owner: nichtich
- License: other
- Created: 2014-07-10T19:34:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-11-06T16:15:52.000Z (about 5 years ago)
- Last Synced: 2024-10-27T17:25:59.014Z (about 2 months ago)
- Language: Perl
- Homepage: https://metacpan.org/pod/Text::MarkdownTable
- Size: 40 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
# NAME
Text::MarkdownTable - Write Markdown syntax tables from data
# STATUS
[](https://travis-ci.org/nichtich/Text-MarkdownTable)
[](https://coveralls.io/r/nichtich/Text-MarkdownTable)
[](http://cpants.cpanauthors.org/dist/Text-MarkdownTable)
# 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
- file
Filename, GLOB, scalar reference or [IO::Handle](https://metacpan.org/pod/IO::Handle) to write to (default STDOUT).
- fields
Array, hash reference, or comma-separated list of fields/columns.
- columns
Column names. By default field names are used.
- widths
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.
- header
Include header lines. Enabled by default.
- edges
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.
- condense
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( $row )
Add a row as hash reference. Returns the table instance.
- streaming
Returns whether rows are directly written or buffered until `done` is called.
- done
Finish and write the table unless it has already been written in `streaming`
mode.
# SEE ALSO
See [Catmandu::Exporter::Table](https://metacpan.org/pod/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:
- [Text::Table::Tiny](https://metacpan.org/pod/Text::Table::Tiny)
- [Text::TabularDisplay](https://metacpan.org/pod/Text::TabularDisplay)
- [Text::SimpleTable](https://metacpan.org/pod/Text::SimpleTable)
- [Text::Table](https://metacpan.org/pod/Text::Table)
- [Text::ANSITable](https://metacpan.org/pod/Text::ANSITable)
- [Text::ASCIITable](https://metacpan.org/pod/Text::ASCIITable)
- [Text::UnicodeBox::Table](https://metacpan.org/pod/Text::UnicodeBox::Table)
- [Table::Simple](https://metacpan.org/pod/Table::Simple)
- [Text::SimpleTable](https://metacpan.org/pod/Text::SimpleTable)
- [Text::SimpleTable::AutoWidth](https://metacpan.org/pod/Text::SimpleTable::AutoWidth)
# AUTHOR
Jakob Voß
# COPYRIGHT AND LICENSE
Copyright 2014- Jakob Voß
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.