search

alexandre-perrin / mkdocs-pandoc-plugin

The plugin is based on mkdocs-mk2pdf-plugin and aims to use pandoc as a generic engine to convert to many document format that pandoc suports.
https://github.com/HaoLiuHust/mkdocs-mk2pdf-plugin
MIT License
6 stars 4 forks source link

Missing hint in documentation #3

Open koffeiniker opened 3 years ago

koffeiniker commented 3 years ago

I honestly believe that a hint, that the pandoc module needs use_directory_urls on false to work properly would be great.

Without this setting, images are expected in a subdirectory for the page by mkdocs but in the docs directly for pandoc. So either maintain symlinks or two copies of images or ... set this config to false. I think the README should reflect this.

alexandre-perrin commented 3 years ago

Hi @koffeiniker

I'm not sure if I understand. This option is meant to create URLs to pages as directories names instead of pages: e.g. https://mypage.org.io/subpage instead of https://mypage.org.io/subpage.html

See https://www.mkdocs.org/user-guide/configuration/#use_directory_urls

It is not meant to modify relative path. I haven't seen any difference in generating with or without this option enabled. Could you provide more information?

Thanks