commonmark-ext-table

by thephpleague

thephpleague /commonmark-ext-table

The table extension for CommonMark PHP implementation

129 Stars 17 Forks Last release: 12 months ago (v2.1.0) MIT License 93 Commits 17 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

CommonMark Table Extension

Latest Version Build Status Code Quality Code Coverage

DEPRECATED

This extension has been deprecated. All of its functionality now exists in

league/commonmark
1.3+ under the

League\CommonMark\Extension\Table
namespace, so you should upgrade to that version and use that bundled extension instead of this one.

Overview

The Table extension adds the ability to create tables in CommonMark documents.

Installation

This project can be installed via Composer:

composer require league/commonmark-ext-table

Usage

Configure your

Environment
as usual and simply add the
TableExtension
provided by this package:
use League\CommonMark\Converter;
use League\CommonMark\DocParser;
use League\CommonMark\Environment;
use League\CommonMark\HtmlRenderer;
use League\CommonMark\Ext\Table\TableExtension;

// Obtain a pre-configured Environment with all the standard CommonMark parsers/renderers ready-to-go $environment = Environment::createCommonMarkEnvironment();

// Add this extension $environment->addExtension(new TableExtension());

// Instantiate the converter engine and start converting some Markdown! $converter = new Converter(new DocParser($environment), new HtmlRenderer($environment));

echo $converter->convertToHtml('# Hello World!');

Syntax

This package is fully compatible with GFM-style tables:

Simple

Code:

markdown
th | th(center) | th(right)
---|:----------:|----------:
td | td         | td

Result:

html
th th(center) th(right
td td td

Advanced

| header 1 | header 2 | header 2 |
| :------- | :------: | -------: |
| cell 1.1 | cell 1.2 | cell 1.3 |
| cell 2.1 | cell 2.2 | cell 2.3 |

Table caption

header 1 | header 2
-------- | --------
cell 1.1 | cell 1.2
[Simple table]

Code:

markdown
header 1 | header 2
-------- | --------
cell 1.1 | cell 1.2
[*Prototype* table][reference_table]

Result:

html
Prototype table
header 1 header 2
cell 1.1 cell 1.2

Changelog

Please refer to the CHANGELOG for more information on what has changed recently.

Development

You need to have php or docker installed to develop the library. To list all available commands run:

./run

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

This library is licensed under the MIT license. See the License File for more information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.