Install instructions needed

[m5c]

Hi,

it seems this repository is currently the most up to date fork of the (assumed) unmaintained mkdocs-with-pdf plugin.

However the README of this repo seems to be unchanged, i.e. if the README install instructions are followed this does not install the code from this repo, but orzih's version, without any of the patches of this repo..

How to install this version ?

Thanks !

[m5c]

Nevermind, figured it out. For everyone else running into this issue... like so: pip install -e git+https://github.com/domWalters/mkdocs-to-pdf.git#egg=mkdocs-with-pdf

[m5c]

Addendum... if you have mermaids, then the only workaround I've found so far is using the branch that prints mermaids as text: pip install -e git+https://github.com/domWalters/mkdocs-to-pdf.git@e26766d#egg=mkdocs-with-pdf (e26766d is the [hash of the tagged version])

And then additionally enable converting of mermaids to PNG with kriki, by adding to your mkdocs.yml:

plugins:
  - search
  - mermaid2
  - with-pdf:
[...]
  - kroki:
      FencePrefix: ''
      FileTypeOverrides:
        mermaid: png

Note: Kroki is a dedicated mkdocs plugin: mkdocs-kroki-plugin==0.9.0

[m5c]

Issued pull request with modified install instructions for README.md Pull request link: https://github.com/domWalters/mkdocs-to-pdf/pull/17