File: githubtable.rst

package info (click to toggle)
terminaltables 3.1.10-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,240 kB
  • sloc: python: 2,988; makefile: 22; sh: 11
file content (27 lines) | stat: -rw-r--r-- 769 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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