https://github.com/czukowski/markdown-tables
RST Grid Tables add-on for cebe/markdown
https://github.com/czukowski/markdown-tables
grid-table markdown rst
Last synced: 5 months ago
JSON representation
RST Grid Tables add-on for cebe/markdown
- Host: GitHub
- URL: https://github.com/czukowski/markdown-tables
- Owner: czukowski
- License: mit
- Created: 2016-09-14T05:21:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-26T13:24:30.000Z (about 9 years ago)
- Last Synced: 2025-05-24T23:43:31.189Z (8 months ago)
- Topics: grid-table, markdown, rst
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Grid Tables for cebe/markdown
=============================
This package adds support for reStructuredText's (RST) [Grid Tables][grid-tables] syntax to [cebe's
Markdown][cebe/markdown] implementation.
The motivation behind it is that technical documentation often requires a support for tables that
are complex, can span rows and columns and contain block elements. Grid Tables for RST provide that,
even though they're harder to type than other table implementations in Markdown.
The current implementation is a port of Grid Tables parser from [Docutils][docutils] module
originally written in Python by David Goodger. Note that Docutils's scope is far greater than Grid
Tables and my intention was not to replicate all of it. One considered extension is eventually
adding support for [Simple Tables][simple-tables] syntax, especially since the current code
structure makes it relatively easy task.
Installation
------------
Recommended installation is via [composer][composer] by running:
composer require czukowski/markdown-tables "~1.0"
Alternatively you may add the following to the `require` section of your project's `composer.json`
manually and then run `composer update` from the command line:
```json
"czukowski/markdown-tables: "~1.0"
```
Usage
-----
This package provides a `RSTTableBlockTrait` that may be used in classes extending the cebe's
original Markdown parsers.
Alternatively, three extensions are provided for easy use (pick one that suits best):
```php
use Cz\Markdown;
$markdownWithRSTTables = new MarkdownWithRSTTables;
$githubMarkdownWithRSTTables = new GithubMarkdownWithRSTTables;
$markdownExtraWithRSTTables = new MarkdownExtraWithRSTTables;
```
For more information refer to the [original Readme file][markdown-usage].
Known Issues
------------
If the tables seem broken, make sure a correct default encoding is set beforehand, for example:
```php
// Set default encoding to UTF-8.
mb_internal_encoding('UTF-8');
```
License
-------
The distribution is permitted under the MIT License. See LICENSE.md for details.
[cebe/markdown]: https://github.com/cebe/markdown
[composer]: https://getcomposer.org/
[docutils]: https://sourceforge.net/projects/docutils/
[grid-tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
[markdown-usage]: https://github.com/cebe/markdown#usage
[simple-tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple-tables