`--build-once` is broken in ReLaXed v0.2.5

[domWalters]

RelaxedJS/ReLaXed#196 broke the --build-once flag.

RelaxedJS/ReLaXed#197 fixes it, but this has never been merged.

We should at least add a warning to the README.

[domWalters]

Having a look at the forks of ReLaXed, it looks like https://github.com/bgachenot/ReLaXed might be the best replacement to suggest. It fixes this bug, and performs package updates.

[alessandroBalliniGPA]

Hi @domWalters , is your enhancement working?
how can i use you 0.9.4 preRelease?

[domWalters]

Hi,

---

If you just want to use the master branch of this repo:

pip install -e git://github.com/domWalters/mkdocs-to-pdf.git

You then use it the same as mkdocs-with-pdf. Although I changed the repo name, I did not go through the code base yet.

It looks like I didn't make a tag or branch for the v0.9.4 stuff which I really should have done.

---

If you need the mermaid fixes for mermaid diagrams:

pip install -e git://github.com/domWalters/mkdocs-to-pdf.git@mermaid-cli

For mermaid you also need the mermaid-cli tool available locally:

npm install -g @mermaid-js/mermaid-cli

---

I was intending on uploading this as a package to PyPi, but I've had a lot going on recently and changed jobs shortly after I made this fork.

If there'd be demand for a PyPi package, please let me know. You may want to open an issue that asks for one.

I'll add a branch / tag for v0.9.4 at some point so you could reference that rather than master, and avoid maybe breaking changes in the future.

[alessandroBalliniGPA]

Installed mermaid-cli version but does not generate mermeid diagrams. It shows script instead of rendered images.
This my plugin section:

plugins:
- mermaid2
- with-pdf:
render_js: true
headless_chrome_path: /usr/bin/google-chrome-stable

[domWalters]

What does the output to the terminal say?

Are there any images generated in the output folder?

---

Hopefully I'll be able to look into this soon, but in the meantime for easier use:

• I've made a release-v0.9.4 branch.
• And a v0.9.4 tag.

Just so any future master changes don't affect you.

---

Are you on a deadline that means this needs to be addressed quickly?

[alessandroBalliniGPA]

This is the output

mkdocsOut.txt

How can i Check that i am using your version during mkdocs build?

This is the build with verbose

mkdocsOutVerbose.txt

server@F12004Portatile:/mnt/d/Lavoro/GPA/TEST/mkdoc$ pip freeze | grep mk
mkdocs==1.6.0
mkdocs-exporter==5.3.1
mkdocs-get-deps==0.2.0
mkdocs-material==9.5.23
mkdocs-material-extensions==1.3.1
mkdocs-mermaid2-plugin==1.1.1
mkdocs-page-pdf==0.1.1
mkdocs-pandoc-plugin==1.0.1
mkdocs-pdf-export-plugin==0.5.10
mkdocs-print-site-plugin==2.4.1
-e git+https://github.com/domWalters/mkdocs-to-pdf.git@e26766d83fe0185b8a5c452daa4450e9c9edceef#egg=mkdocs_with_pdf

[domWalters]

Can you try disable the mermaid2 plugin and see what happens?

Looking at that mkdocsOut.txt file, it seems like mermaid2 is doing basically the same thing that with_pdf is trying to do.

In your case, I'd expect 7 lines of output saying "Converting mermaid diagram #" where # is a number starting at 0 ending at 6.

I think mermaid2 is doing a conversion before with_pdf can. So with_pdf never sees the mermaid code.

[alessandroBalliniGPA]

With mermeid2 activated:

Without mermeid2:

[domWalters]

Right, it looks like a newer mkdocs version changed the HTML for mermaid diagrams from:

<pre class="mermaid"><code>...

...to...

<pre><code class="language-mermaid">...

So the regex in drivers/headless_chrome.py misses the match.

This patch seems to work:

diff --git a/drivers/headless_chrome.py b/drivers/headless_chrome.py
index 6f4debb..ec97067 100644
--- a/drivers/headless_chrome.py
+++ b/drivers/headless_chrome.py
@@ -24,7 +24,7 @@ class HeadlessChromeDriver(object):

     def render(self, html: str, temporary_directory: pathlib.Path) -> str:
         try:
-            mermaid_regex = r'<pre><code class="language-mermaid">(.*?)</code></pre>'
+            mermaid_regex = r'<pre class="mermaid"><code>(.*?)</code></pre>'
             mermaid_matches = re.findall(mermaid_regex, html, flags=re.DOTALL)

             # Convert each Mermaid diagram to an image.
@@ -47,7 +47,7 @@ class HeadlessChromeDriver(object):

                 # Replace the Mermaid code with the image in the HTML string.
                 image_html = f'<img src="file://{image_file_path}" alt="Mermaid diagram {i+1}">'
-                html = html.replace(f'<pre><code class="language-mermaid">{mermaid_code}</code></pre>', image_html)
+                html = html.replace(f'<pre class="mermaid"><code>{mermaid_code}</code></pre>', image_html)

             self._logger.info(f"Post mermaid translation: {html}")
             with open(temporary_directory / "post_mermaid_translation.html", "wb") as temp:

[domWalters]

I just added this patch to the mermaid-cli branch.

I also upped the minimum mkdocs version to v1.6.0 to match.

Can you try that and report back?

[alessandroBalliniGPA]

With mermaid2 activated:

without mermaid2 now there is something different:

i see some files .mmd in temp dir

[domWalters]

Can you send me the terminal output?

The generated diagrams should be .png files that get made from the .mmd files by the mmdc (mermaid-cli) tool.

This would suggest to me that mmdc isn't available in the PATH where mkdocs is being executed.

You might have an environment setup issue now.

[alessandroBalliniGPA]

That is:

[domWalters]

Ah, your installed version of node is too old for the mmdc you have. I would get this same error in Ubuntu 20.04, is that what you're using?

The newest version of mmdc needs node 16 or higher, I don't know which one npm would have installed for you.

Not sure what your system setup is like, or how easy it would be for you to upgrade the system node (I'd avoid upgrading the system node personally), but you could look into using nvm:

https://github.com/nvm-sh/nvm

[alessandroBalliniGPA]

Wow, strange colors but now generated! there is a configuration to remove or set " -t dark" option?

P.S.
with this branch now there are a lot of verbose html in output