Description
When exporting a Markdown file containing Mermaid diagrams, the diagrams are not rendered correctly (they remain as code blocks) unless the markdown-pdf.executablePath is explicitly set. Although a similar issue has been reported in #342, I would like to propose an improvement to the documentation (README) to help users resolve this configuration requirement more easily.
Steps to Reproduce
Environment
- OS: Windows 11 Pro 25H2 (Confirmed also on macOS and Ubuntu)
- VS Code: 1.109.2
- Extension Version: 1.5.0
Sample Code
```mermaid
stateDiagram
[*] --> First
state First {
[*] --> second
second --> [*]
}
```
Procedures
- Leave
markdown-pdf.executablePath as default (empty).
- Right-click the editor and select "Markdown PDF: Export (PNG)".
- Check the output result.
- Set the
markdown-pdf.executablePath (following the English Documentation).
- Export again and check the output.
Results
| Setting |
Output Result |
| Not Configured |
 |
| Configured |
 |
Note: The same behavior was observed on macOS and Ubuntu environments.
Proposed Improvement
I suggest updating the README to clarify this requirement for Mermaid users:
- Add a direct link to the
markdown-pdf.executablePath section near the Mermaid input example.
- Add a note to the
markdown-pdf.executablePath description:
"When using diagram features like Mermaid, this setting may be required for proper rendering. Otherwise, diagrams may be output as raw code blocks."
I would be happy to submit a Pull Request (PR) to update both README.md and README.ja.md with these improvements if you agree with this proposal. Please let me know what you think!
Description
When exporting a Markdown file containing Mermaid diagrams, the diagrams are not rendered correctly (they remain as code blocks) unless the
markdown-pdf.executablePathis explicitly set. Although a similar issue has been reported in #342, I would like to propose an improvement to the documentation (README) to help users resolve this configuration requirement more easily.Steps to Reproduce
Environment
Sample Code
Procedures
markdown-pdf.executablePathas default (empty).markdown-pdf.executablePath(following the English Documentation).Results
Note: The same behavior was observed on macOS and Ubuntu environments.
Proposed Improvement
I suggest updating the README to clarify this requirement for Mermaid users:
markdown-pdf.executablePathsection near the Mermaid input example.markdown-pdf.executablePathdescription:I would be happy to submit a Pull Request (PR) to update both
README.mdandREADME.ja.mdwith these improvements if you agree with this proposal. Please let me know what you think!