Instead of aligning tables using one of the standard Markdown extensions, you can use your editor of choice. In this way, the following file... ...will render like so: Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch CSV :include-table: table.csv CSV Account, Price, Description #12BGD3, 100, custom table with a long attachment #12BGD4, 90, custom table with a short attachment #12BGD5, 150, chair #91AGB1, 10, lunch
This extension can be used to display data from a file representing tabular data. So the following file... ...will render like so: Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch JSON :include-table: table.json JSON [ { "Account": "#12BGD3", "Price": 100, "Description": "custom table with a long attachment" }, { "Account": "#12BGD3", "Price": 150, "Description": "chair" }, { "Account": "#91AGB1", "Price": 10, "Description": "lunch" } ]
Use parameter to set a table title. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch title :include-table: table.json {title: "Monthly Report"}
When you specify a title, hover mouse over it to see a clickable anchor. Use to override auto generated identifier. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch anchorId :include-table: table/table.json {title: "Monthly Report", anchorId: "my-super-table"}
Use to make image collapsible. Note: option is required Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch collapsed: true|false title :include-table: table/table.json { title: "Monthly Report", collapsed: true }
Use to remove top/bottom margins when there are multiple tables in a row. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch noGap: true :include-table: table/table.json { title: "Monthly Report", collapsed: true, noGap: true } :include-table: table/table.json { title: "Weekly Report", collapsed: false }
Use to highlight a row, or a set of rows by their index Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch highlightRow :include-table: table/table.json {title: "Highlight multiple rows", highlightRow: [0, 2]} :include-table: table/table.json {title: "Highlight single row", highlightRow: 1}
Arrange and Remove Columns
To change the order of columns or to filter out certain columns, specify the parameter. Description Price custom table with a long attachment 100 custom table with a short attachment 90 chair 150 lunch 10 columns :include-table: table.csv {columns: ["Description", "Price"]}
Use to include only rows that match a regular expression Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair Use to exclude rows that match a regular expression Account Price Description #12BGD3 100 custom table with a long attachment #12BGD5 150 chair :include-table: table/table.csv {includeRowsRegexp: ["table", "cha.."]} :include-table: table/table.csv {includeRowsRegexp: ["table", "cha.."], excludeRowsRegexp: "short"}
By default, columns width is auto-calculated to fit the values inside. Use to control the width of a column. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch Use percentage value to change column size relative to the page content width. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch Note: total percentage of all columns can go above 100%, in which case a scroll bar will be used to fit the content Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch width :include-table: table.csv {Price: {width: 200}, "Description": {width: 400}} :include-table: table/table.csv {Price: {width: "50%"}, "Description": {width: "30%"}} :include-table: table/table.csv {Price: {width: "50%"}, "Description": {width: "60%"}}
Use prefix if a column name matches the plugin parameter name like when setting column specific parameters. account title #12BGD3 custom table with a long attachment #12BGD4 custom table with a short attachment _ title :include-table: table/table-conflict.csv {"_title": {width: "80%"}}
Use to set min width for all table columns Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch minColumnWidth :include-table: table/table.csv {minColumnWidth: 400, "Description": {width: 500}}
Use to make table occupy all available width Account Price Zip Code Rating Description #12BGD3 100 11111 4 custom table with a long attachment #12BGD3 150 22222 5 chair #91AGB1 10 33333 4.5 lunch wide: true :include-table: table/table.csv {wide: true, minColumnWidth: 400, title: "My Items"}
Use to change a column text alignment. Account Price Description #12BGD3 100 custom table with a long attachment #12BGD4 90 custom table with a short attachment #12BGD5 150 chair #91AGB1 10 lunch data example: Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch align :include-table: table.csv {Price: {width: 200, align: "right"}} JSON :include-table: table.json {Price: {width: 100, align: "right"}}
Use to provide a way to override table values using mapping table. Feature Name V1 V2 featureA `:icon: check {stroke: "green"}` `:icon: check {stroke: "green"}` featureB `:icon: slash {stroke: "red"}` `:icon: check {stroke: "green"}` Note: We used Icons in this example, but you can use any plugins or any text you want. mappingPath Feature Name, V1, V2 featureA, +, + featureB, -, + +, `:icon: check {stroke: "green"}` -, `:icon: slash {stroke: "red"}` :include-table: table.csv {mappingPath: "mapping.csv"}
Account Price Description #12BGD3 100 custom table with a long attachment #12BGD3 150 chair #91AGB1 10 lunch ```table {title: "my table", Price: {width: 100, align: "right"}} Account, Price, Description #12BGD3, 100, custom table with a long attachment #12BGD3, 150, chair #91AGB1, 10, lunch ```
Use quotes to provide multi line markdown content such as bullet points and code snippets Account Price Description #12BGD3 100 multi line markdown with * bullet point * list #12BGD3 150 and some code snippet ```java class HelloWorld { } ``` Account, Price, Description #12BGD3, 100, "multi line markdown with * bullet point * list " #12BGD3, 150, "and some code snippet ```java class HelloWorld { } ``` "
You can use Markdown table syntax within your table file. Account Price Description #12BGD3 100 **custom** table with a long attachment #12BGD3 150 chair #91AGB1 10 `lunch` Account, Price, Description #12BGD3, 100, **custom** table with a long attachment #12BGD3, 150, chair #91AGB1, 10, `lunch`
Github Flavored Table [{text=col 3 is, type=SimpleText}] [{text=right-aligned, type=SimpleText}] [{text=$1600, type=SimpleText}] [{text=col 2 is, type=SimpleText}] [{text=centered, type=SimpleText}] [{text=$12, type=SimpleText}] | Github | Flavored | Table | | ------------- |:-------------:| -----:| | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 |