mkdocs-table-reader-plugin

What it is and what it does

mkdocs-table-reader-plugin extends MkDocs with a template tag system that reads tabular data from external files and renders them as markdown tables inline. Instead of manually copying table content into your documentation, you reference the file directly—the plugin handles parsing CSV, JSON, Excel, YAML, TSV, and other formats, then inserts the rendered table into the page at build time.

The plugin depends on mkdocs, pandas, tabulate, and PyYAML to handle file reading and formatting. It integrates with MkDocs' plugin system and is compatible with mkdocs-macros-plugin for more advanced automation like filtering or batch-inserting directories of tables. The workflow is useful for keeping documentation synchronized with live data files or for building reproducible reports where tables update automatically when source files change.

Use it for

• Keep documentation tables synchronized with CSV or Excel source files without manual copy-paste
• Build reproducible reports where tables update automatically when underlying data files change
• Insert multiple tables from different file formats into a single MkDocs page using template tags
• Combine with mkdocs-macros-plugin to filter or transform tables before rendering them in documentation
• Generate data-driven documentation where tables are sourced from JSON or YAML configuration files

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

mkdocs-table-reader-plugin on PyPI

Before you install

Low install friction; pure Python wheel with straightforward dependencies. Maintenance status is aging—last release was 715 days ago, though the repository remains active with a recent commit on 2025-04-19. Suitable for stable documentation workflows but not under active development.

Requires MkDocs to be installed and configured; file paths are resolved relative to mkdocs.yml, docs/ directory, or the markdown source file.

License in practice

MIT license (permissive) means you can use, modify, and distribute this plugin freely in both open and closed projects with minimal restrictions.

Quickstart

pip install mkdocs-table-reader-plugin

Add to mkdocs.yml:
plugins:
  - search
  - table-reader

In markdown:
{{ read_csv('path_to_table.csv') }}

Package facts

Evidence: mkdocs_table_reader_plugin-3.1.0-py3-none-any.whl

Tags

More Documentation packages

See also mkdocs-macros-plugin · mkdocs-video · mkdocs-plugin-inline-svg · mkdocs-markdownextradata-plugin · mkdocs-meta-manager · mkdocs-include-markdown-plugin · markdown-table · mkdocs-embed-external-markdown · mkdocs-print-site-plugin · mkdocs-task-collector