maddhatter/markdown-table

Dynamically generate markdown tables

1.2.0 2023-05-11 13:28 UTC

This package is auto-updated.

Last update: 2024-10-10 13:07:09 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License Build Status

A small package to dynamically generate Markdown tables, as described here.

Install

Install using composer:

composer require maddhatter/markdown-table

Usage

// create instance of the table builder
$tableBuilder = new \MaddHatter\MarkdownTable\Builder();

// add some data
$tableBuilder
	->headers(['Tables','Are','Cool']) //headers
	->align(['L','C','R']) // set column alignment
	->rows([ // add multiple rows at once
		['col 1 is', 'left-aligned', '$1600'],
		['col 2 is', 'centered', '$12'],
	])
	->row(['col 3 is', 'right-aligned', '$1']); // add a single row

// display the result
echo $tableBuilder->render();

Result

| Tables   |      Are      |  Cool |
|----------|:-------------:|------:|
| col 1 is | left-aligned  | $1600 |
| col 2 is |   centered    |   $12 |
| col 3 is | right-aligned |    $1 |