diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-16 09:09:35 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-09-16 09:09:35 +0000 |
| commit | 0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7 (patch) | |
| tree | a0b651b55ea02e3b00bbc5eedba566fdd6bd7c08 /docs/githubtable.rst | |
| parent | Initial commit. (diff) | |
| download | terminaltables-0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7.tar.xz terminaltables-0dfe1c9e2780469e3a4696e8fb3e6f717a7ebeb7.zip | |
Adding upstream version 3.1.0.upstream/3.1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/githubtable.rst')
| -rw-r--r-- | docs/githubtable.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/githubtable.rst b/docs/githubtable.rst new file mode 100644 index 0000000..ba53218 --- /dev/null +++ b/docs/githubtable.rst @@ -0,0 +1,27 @@ +.. _githubtable: + +=========================== +GithubFlavoredMarkdownTable +=========================== + +GithubFlavoredMarkdownTable was initially implemented bcho_. It produces a `GitHub Flavored Markdown`_ formatted table. + +Because there are no outer table borders: + +* Table titles are ignored. +* Border display toggles are also ignored. + +.. image:: githubtable.png + :target: _images/githubtable.png + +.. image:: githubtable_rendered.png + :target: _images/githubtable_rendered.png + +API +=== + +.. autoclass:: terminaltables.GithubFlavoredMarkdownTable + :members: column_max_width, column_widths, ok, table_width, table + +.. _bcho: https://github.com/Robpol86/terminaltables/pull/12 +.. _GitHub Flavored Markdown: https://help.github.com/categories/writing-on-github |