mkdocs-table-reader-plugin
MkDocs plugin that enables a markdown tag like {{ read_csv('table.csv') }} to directly insert various table formats into a page.
For a workflow with other plugins see the blogpost building reproducible reports with MkDocs
Installation
Install the plugin using pip:
pip install mkdocs-table-reader-plugin
Next, add the following lines to your mkdocs.yml:
plugins:
- search
- table-reader
If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.
Usage
In your markdown files 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, or your project's docs/ directory, or the location of your markdown source file (all 3 possible locations will be searched, in that order).
- There are readers available for many common table formats, like
.csv,.fwf,.json,.xls,.xlsx,.yaml,.feather,.tsv,.parquet,.orc,.htmland.xml, as well as HDF5, SPSS, SAS and Stata files. There is also theread_raw()reader that will allow you to insert tables (or other content) already in markdown format. table-readeris compatible withmkdocs-macros-plugin. This enables further automation like filtering tables or inserting directories of tables. See the documentation on compatibility with macros plugin for more examples.
Documentation and how-to guides
1 maintainer
Release files for mkdocs-table-reader-plugin 4.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_table_reader_plugin-4.0.1.tar.gz | 230.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_table_reader_plugin-4.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 242.4 kB
Release files / mkdocs_table_reader_plugin-4.0.1.tar.gz
| Download URL | mkdocs_table_reader_plugin-4.0.1.tar.gz |
|---|---|
| Size | 230.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
77c3b60eb7026b0de0711428f0b996ca7633486a8ff80956c99761625f97f06b
|
|
BLAKE2b-256 checksum How to use checksums |
9bce9391d14a0300ee0c41cfd85761baf2c0216d80f71d3b6a1bf245227bb656
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency logRelease files / mkdocs_table_reader_plugin-4.0.1-py3-none-any.whl
| Download URL | mkdocs_table_reader_plugin-4.0.1-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
94deefda2e8090b38d596d5da5d0eefb75cabfa6f675d4e860b98ef0e89adb19
|
|
BLAKE2b-256 checksum How to use checksums |
a7d8cbc782099f4b73512d685271ae56747d1ecf6779dfac0ac25543ab3e39dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.
Transparency log
