Omit Graphviz installation check for Windows (#2369)

MarkBind · Sep 16, 2023 · 2664920 · 2664920
1 parent ec12bfb
commit 2664920
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/userGuide/siteJsonFile.md b/docs/userGuide/siteJsonFile.md
@@ -302,7 +302,7 @@ To disable this validation **entirely**, you may add the following to `site.json
 
 #### **`plantumlCheck`**
 
-**Toggle whether to display a warning about PlantUML's prerequisite.** By default, MarkBind will check if you have Graphviz installed when you are using PlantUML diagrams.
+**Toggle whether to display a warning about PlantUML's prerequisite. Only applicable for non-Windows users.** By default, MarkBind will check if you have Graphviz installed when you are using PlantUML diagrams.
 To disable this validation and the display of the warning, you may add the following to `site.json`:
 <div id="plantuml-check">
 

diff --git a/docs/userGuide/syntax/diagrams.md b/docs/userGuide/syntax/diagrams.md
@@ -8,7 +8,7 @@ You can use the [PlantUML](http://plantuml.com/) syntax to add diagrams.
 
 * Java 8 or higher (required - to run the PlantUML JAR executable)
 * [Graphviz](https://www.graphviz.org/download/) {{ graphviz_version }} or higher (optional - you don't need this if you are on Windows, or only need [sequence diagrams](https://plantuml.com/sequence-diagram) and [activity (beta) diagrams](https://plantuml.com/activity-diagram-beta))
-  * A warning will be displayed if you don't have Graphviz installed (ignore this warning if you are on Windows). To disable this warning, you may modify your `site.json` like <trigger for="pop:prerequisite-disable" placement="bottom" trigger="click">this</trigger>.
+  * A warning will be displayed if you are using a non-Windows platform and don't have Graphviz installed. To disable this warning, you may modify your `site.json` like <trigger for="pop:prerequisite-disable" placement="bottom" trigger="click">this</trigger>.
   * An alternative layout engine, [Smetana](https://plantuml.com/smetana02), is integrated into PlantUML and can be used to generate diagrams without a Graphviz installation. However, as the Smetana engine is a work in progress, certain layouts may not render correctly. 
 
 <modal header="Disabling PlantUML's prerequisite check in `site.json`" id="pop:prerequisite-disable" backdrop>

diff --git a/packages/core/src/plugins/default/markbind-plugin-plantuml.ts b/packages/core/src/plugins/default/markbind-plugin-plantuml.ts
@@ -120,7 +120,7 @@ export = {
     if (node.name !== 'puml') {
       return;
     }
-    if (config.plantumlCheck && !graphvizCheckCompleted) {
+    if (process.platform !== 'win32' && config.plantumlCheck && !graphvizCheckCompleted) {
       exec(`java -jar "${JAR_PATH}" -testdot`, (_error, _stdout, stderr) => {
         if (stderr.includes('Error: No dot executable found')) {
           logger.warn('You are using PlantUML diagrams but Graphviz is not installed!');