diff options
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 |