timvink / 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
https://timvink.github.io/mkdocs-table-reader-plugin/
MIT License
124 stars 20 forks source link

Add new option 'base_path' #26

Closed timvink closed 2 years ago

timvink commented 2 years ago

Follow-up from discussion: https://github.com/timvink/mkdocs-table-reader-plugin/commit/a60cdaff168697eb2793fee400228e56851a9115#commitcomment-76888466

ghost commented 2 years ago

Thanks. Will review/test this week.

ghost commented 2 years ago

Thanks. Will review/test this week.

It's great, works for my use case, and is more flexible than before. Thanks.

timvink commented 2 years ago

Thanks for the review, testing, and for this researching this option with me! Fun to collaborate.

timvink commented 2 years ago

Released: https://github.com/timvink/mkdocs-table-reader-plugin/releases/tag/v1.1.0

ghost commented 2 years ago

Thanks for the review, testing, and for this researching this option with me! Fun to collaborate.

Not at all, a pleasure, and thank you for a great and useful plugin. Paul.

timvink commented 2 years ago

Unrelated, but I read your comment on https://github.com/fotrimzi/mkdocs2org

It also needs a MkDocs plugin to create a single HTML file for the site, and rewrite the relative links into internal ones. So far, I’ve not found a way to do this. I have briefly looked at mkdocs-combine and mkdocs-with-pdf but haven’t got their intermediate one-page HTML to convert easily.

I wrote a plugin to do just that (combine all files into a single page). Never again, as there were so many edge cases to solve. Have you tried https://github.com/timvink/mkdocs-print-site-plugin ?

ghost commented 2 years ago

I may have tried it (honestly, I can't remember) but I will give it another spin. Such plugins tend to be for printing a site, so I can imagine how messy it can get dealing with styling, pages, intermediate formats... I don't need all that, just a MkDocs site rendered as a single page. Sphinx-doc (my first experience with techdoc SSGs) has a build target for that, and I just naively assumed MkDocs would have the same. But I guess that's what plugins are for. Anyway, thanks for the tip.

ghost commented 2 years ago

https://github.com/fotrimzi/mkdocs-showcase/blob/main/docs/pdf.md#see-also

So I've previously stumbled over it but didn't look any further. I will now!