Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thephpleague/commonmark-ext-table
The table extension for CommonMark PHP implementation
https://github.com/thephpleague/commonmark-ext-table
commonmark table
Last synced: 3 months ago
JSON representation
The table extension for CommonMark PHP implementation
- Host: GitHub
- URL: https://github.com/thephpleague/commonmark-ext-table
- Owner: thephpleague
- License: mit
- Archived: true
- Created: 2015-05-26T14:23:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-04T15:53:25.000Z (over 4 years ago)
- Last Synced: 2024-07-23T04:03:32.012Z (4 months ago)
- Topics: commonmark, table
- Language: PHP
- Size: 128 KB
- Stars: 128
- Watchers: 8
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
CommonMark Table Extension
==========================
[](https://packagist.org/packages/league/commonmark-ext-table)
[](https://travis-ci.org/thephpleague/commonmark-ext-table)
[](https://scrutinizer-ci.com/g/thephpleague/commonmark-ext-table/code-structure)
[](https://scrutinizer-ci.com/g/thephpleague/commonmark-ext-table)
## DEPRECATED
**This extension has been deprecated**. All of its functionality now exists in [`league/commonmark`](https://github.com/thephpleague/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:
```php
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<)/th>
td
td
td
```
### Advanced
```markdown
| 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
```markdown
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](CHANGELOG.md) 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:
```bash
./run
```
Security
--------
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
-------
- [Martin Hasoň](https://github.com/hason)
- [Webuni s.r.o.](https://www.webuni.cz)
- [Colin O'Dell](https://github.com/colinodell)
- [All Contributors](../../contributors)
License
-------
This library is licensed under the MIT license. See the [License File](LICENSE) for more information.