Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
mkdocs-table-reader-plugin
Advanced tools
MkDocs plugin to directly insert tables from files into markdown.
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
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
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 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).
.csv
, .fwf
, .json
, .xls
, .xlsx
, .yaml
, .feather
and .tsv
. There is also the read_raw()
reader that will allow you to insert tables (or other content) already in markdown format.table-reader
is compatible with mkdocs-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.FAQs
MkDocs plugin to directly insert tables from files into markdown.
We found that mkdocs-table-reader-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.