CSV Tables in Markdown: Pandoc Filter for CSV Tables
Project description
- Date:
- November 22, 2016
CSV Tables in Markdown: Pandoc Filter for CSV Tables
This allows CSV tables, optionally containing markdown syntax (enabled by default), to be put in markdown as a fenced code blocks.
Example
This won’t work on GitHub’s markdown rendering nor PyPI. 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:
|
2 |
Any markdown syntax, e.g. |
\begin{equation*}
E = mc^2
\end{equation*}
|
Table: Awesome Markdown Table
Install and Use
Install:
pip install -U pantableUse:
pandoc -F pantable -o README.html README.mdSyntax
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.4Default: 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
