alexandre-perrin / mkdocs-pandoc-plugin Goto Github PK

Hi - I've noticed two problems when running mkdocs build:

1. Combined pdf is a markdown file called combined.pdf.md
2. Attempts to convert from pdf files instead of to pdf

Can you suggest anything to fix?

Combined markdown instead of pdf

When I set combined=true, the resulting combined file from mkdocs build is a markdown file that combines all other files, instead of a pdf.

Settings are as below:

plugins:
  - search
  - pandoc:          # requires mkdocs-pandoc-plugin
      # enabled_if_env: ENABLE_PANDOC_EXPORT
      combined: true

Attempts to convert from pdf

There are repeated errors in the terminal like this:

Unknown input format pdf
Pandoc can convert to PDF, but not from PDF.

With combined=true then the combined file is created as a markdown (as above).

If I set combined=false, then no pdf files are created in the subdirectories of mkdocs_site/pandoc.

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.

In plugin.py about line 110 the indentation is wrong. The modify_html-call must be indented one level further to be part of the else-branch. Otherwise, when combined is true, both links will be injected, one being stale as with combined on the individual page-pdfs do not get generated.

I've just installed mkdocs-pandoc-plugin and the pandoc_template keyword isn't recognised.

WARNING - Config value 'plugins': Plugin 'pandoc' option 'pandoc_template': Unrecognised configuration name: pandoc_template

My mkdocs.yml settings are as below:

plugins:
  - search
  - pandoc:          # requires mkdocs-pandoc-plugin
      # enabled_if_env: ENABLE_PANDOC_EXPORT
      combined: true
      combined_output_path: pandoc/combined.pdf
      pandoc_template: eisvogel

The below reference seems to be where you create the combined md file without taking into account relative path links in the sourced md files. Thus, when the end combined document gets created, the images or relative links will not load. (Specifically I was testing images in md files). I have a multi-level folder structure. I think if you had a fairly basic mkdocs documentation it would not be an issue, or you could strategically place your images to resolve the issue.

I wanted to open this issue to see if this has been thought through.