Skip to content

Commit 729c53c

Browse files
authored
Update README.md
1 parent c83ea54 commit 729c53c

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

+29-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<img src="https://raw.githubusercontent.com/PyxTerm/xTerm/main/.github/workflows/Typographic.png" title="xterm Python Package" alt="python Package xTerm" width="auto" height="auto">
22

33
# xTerm
4-
5-
64
## Install
75

86
Windows Install with `pip`
@@ -134,9 +132,32 @@ table = Table([
134132

135133
---
136134

137-
138-
More details : [table](https://github.com/PyxTerm/xTerm/blob/main/docs/table.md)
139-
140-
141-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PyxTerm/xTerm/HEAD)
142-
135+
### Table formatting
136+
137+
There is more than one way to format a table in plain text. The third optional argument named tablefmt defines how the
138+
table is formatted.
139+
140+
Supported table formats are:
141+
142+
| Parameter | Type | Value | Parameter | Type | Value |
143+
|:-------------|:--------:|:------------------|--------------:|:--------:|:------------------|
144+
| **tablefmt** | _string_ | `plain` | **tablefmt** | _string_ | `orgtbl` |
145+
| **tablefmt** | _string_ | `simple` | **tablefmt** | _string_ | `asciidoc` |
146+
| **tablefmt** | _string_ | `github` | **tablefmt** | _string_ | `jira` |
147+
| **tablefmt** | _string_ | `grid` | **tablefmt** | _string_ | `presto` |
148+
| **tablefmt** | _string_ | `simple_grid` | **tablefmt** | _string_ | `pretty` |
149+
| **tablefmt** | _string_ | `rounded_grid` | **tablefmt** | _string_ | `psql` |
150+
| **tablefmt** | _string_ | `heavy_grid` | **tablefmt** | _string_ | `rst` |
151+
| **tablefmt** | _string_ | `mixed_grid` | **tablefmt** | _string_ | `mediawiki` |
152+
| **tablefmt** | _string_ | `double_grid` | **tablefmt** | _string_ | `moinmoin` |
153+
| **tablefmt** | _string_ | `fancy_grid` | **tablefmt** | _string_ | `youtrack` |
154+
| **tablefmt** | _string_ | `outline` | **tablefmt** | _string_ | `html` |
155+
| **tablefmt** | _string_ | `simple_outline` | **tablefmt** | _string_ | `unsafehtml` |
156+
| **tablefmt** | _string_ | `rounded_outline` | **tablefmt** | _string_ | `latex` |
157+
| **tablefmt** | _string_ | `heavy_outline` | **tablefmt** | _string_ | `latex_raw` |
158+
| **tablefmt** | _string_ | `mixed_outline` | **tablefmt** | _string_ | `latex_booktabs` |
159+
| **tablefmt** | _string_ | `double_outline` | **tablefmt** | _string_ | `latex_longtable` |
160+
| **tablefmt** | _string_ | `fancy_outline` | **tablefmt** | _string_ | `textile` |
161+
| **tablefmt** | _string_ | `pipe` | **tablefmt** | _string_ | `tsv` |
162+
163+
More details : [table](https://xterm.readthedocs.io/en/latest/table/ 'xTerm Table Terminal') | [Notebook Example](https://deepnote.com/app/vector3/xTerm-5a0d16cf-d30e-4373-8564-4b5f7b2d0ed3)

0 commit comments

Comments
 (0)