1
0
Fork 0
terminaltables/docs/githubtable.rst
Daniel Baumann a35389c891
Adding upstream version 3.1.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-12 13:04:33 +01:00

27 lines
769 B
ReStructuredText

.. _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