MkDocs plugin that adds a {{ read_csv('table.csv') }}
markdown tag to directly insert CSV files as a table into a page. Other supported table file formats are excel (.xls
, .xlsx
), fixed-width (.fwf
), json (.json
) and yaml (.yaml
).
For a workflow with other plugins see the blogpost building reproducible reports with MkDocs
Install the plugin using pip3
:
pip3 install mkdocs-table-reader-plugin
Next, add the following lines to your mkdocs.yml
:
plugins:
- search
- table-reader
If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set.
In your markdown documents you can now use:
{{ read_csv('path_to_table.csv') }}
Where the path is relative to the location of your project's mkdocs.yml
file (although you can change that to be relative to your docs/
directory).