table-reader v3.0.0
What's Changed
table-reader
is now compatible withmkdocs-macros-plugin
, which means you can dynamically insert tables using jinja2 syntax.- The
base_path
option has now been deprecated (and will log a warning when used). Now by default, the config_dir (path to yourmkdocs.yml
file) and docs_dir (path to yourdocs/
dir) will always be searched when looking for a table file path - The
search_page_directory
option has now been deprecated (and will log a warning when used). The markdown page's source file directory will always be searched when looking for a table file.
Breaking changes / upgrading guide
- Remove
base_path
andsearch_page_directory
from yourmkdocs.yml
options.
# mkdocs.yml
plugins:
- - table-reader:
- base_path: docs_dir
- search_page_directory: True
+ - table-reader
- In your
mkdocs.yml
file, themacros
plugin should be defined before thetable-reader
plugin (previously this was after)
# mkdocs.yml
plugins:
- - table-reader
- - macros
+ - macros
+ - table-reader
Full Changelog: v2.2.2...v3.0.0