pantable 0.3

CSV Tables in Markdown: Pandoc Filter for CSV Tables

Date:

November 22, 2016

Contents

• CSV Tables in Markdown: Pandoc Filter for CSV Tables

• Example

• Install and Use

• Syntax

• Related Filters

CSV Tables in Markdown: Pandoc Filter for CSV Tables

This allows CSV tables, optionally containing markdown syntax (disabled by default), to be put in markdown as a fenced code blocks.

Example

Also see the README in GitHub Pages. There’s a LaTeX output too.

```table
---
caption: '*Awesome* **Markdown** Table'
alignment: RC
table-width: 0.7
markdown: True
---
First row,defaulted to be header row,can be disabled
1,cell can contain **markdown**,"It can be aribrary block element:

- following standard markdown syntax
- like this"
2,"Any markdown syntax, e.g.",$$E = mc^2$$
```

becomes

First row	defaulted to be header row	can be disabled
1	cell can contain markdown	It can be aribrary block element: following standard markdown syntax like this
2	Any markdown syntax, e.g.	\begin{equation*} E = mc^2 \end{equation*}

Table: Awesome Markdown Table

(The equation might not work if you view this on PyPI.)

Install and Use

Install:

pip install -U pantable

Use:

pandoc -F pantable -o README.html README.md

Syntax

Fenced code blocks is used, with a class table. See Example.

Optionally, YAML metadata block can be used within the fenced code block, following standard pandoc YAML metadata block syntax. 7 metadata keys are recognized:

• caption: the caption of the table. If omitted, no caption will be inserted. Default: disabled.

• alignment: a string of characters among L,R,C,D, case-insensitive, corresponds to Left-aligned, Right-aligned, Center-aligned, Default-aligned respectively. e.g. LCRD for a table with 4 columns. Default: DDD...

• width: a list of relative width corresponding to the width of each columns. e.g.

  - width
      - 0.1
      - 0.2
      - 0.3
      - 0.4

  Default: auto calculated from the length of each line in table cells.

• table-width: the relative width of the table (e.g. relative to \linewidth). default: 1.0

• header: If it has a header row or not. True/False/yes/NO are accepted, case-insensitive. default: True

• markdown: If CSV table cell contains markdown syntax or not. Same as above. Default: False

• include: the path to an CSV file, can be relative/absolute. If non-empty, override the CSV in the CodeBlock. default: None

When the metadata keys is invalid, the default will be used instead.

Related Filters

The followings are pandoc filters written in Haskell that provide similar functionality. This filter is born after testing with theirs.

• baig/pandoc-csv2table: A Pandoc filter that renders CSV as Pandoc Markdown Tables.

• mb21/pandoc-placetable: Pandoc filter to include CSV data (from file or URL)

• sergiocorreia/panflute/csv-tables.py

	pandoc-csv2table	pandoc-pla cetable	panflute example	pantable
capti on	caption	caption	title	caption
align s	aligns = LRCD	aligns = L RCD		aligns = LRCD
width		widths = ” 0.5 0.2 0. 3”		width: [0.5, 0.2, 0.3]
table -widt h				table-width: 1.0
heade r	header = yes | no	header = y es | no	header: T rue | Fa lse	header: True | False | y es | NO
markd own		inlinemark down		markdown: True | False | yes | NO
sourc e	source	file	source	include
other s	type = simple | mu ltiline | grid | pipe
		delimiter
		quotechar
		id (wrappe d by div)
Notes				width are auto-calculated when width is not specifie d