Using tables
1 month ago
Basic table syntax
Use the following format for tables:
[cols=4*, options="header"]
|===
| Key
| Required
| Type
| Description
| Version
| Y
| String
| Should currently be `2`
|===Looks like:
| Key | Required | Type | Description |
|---|---|---|---|
Version |
Y |
String |
Should currently be |
Extra wide tables
If you have a wide table that needs to scroll, wrap it in a scrollable container, as follows:
[.table-scroll]
--
[cols=4*, options="header"]
|===
| Key
| Required
| Type
| Description
| ++Some+very+long+text+that+can't+wrap+so+the+table+needs+to+scroll+Some+very+long+text+that+can't+wrap+so+the+table+needs+to+scroll++
| Some data
| Some more data
| Some more data
|===
--Looks like:
| Key | Required | Type | Description |
|---|---|---|---|
Some+very+long+text+that+can't+wrap+so+the+table+needs+to+scroll+Some+very+long+text+that+can't+wrap+so+the+table+needs+to+scroll |
Some data |
Some more data |
Some more data |
Advanced table options
There are a lot of options for formatting tables, cell, rows, columns. For more information, see the Asciidoctor docs