diff --git a/docs/userGuide/siteJsonFile.md b/docs/userGuide/siteJsonFile.md index fdd2e5edff..4e77c73fbe 100644 --- 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`:
diff --git a/docs/userGuide/syntax/diagrams.md b/docs/userGuide/syntax/diagrams.md index 08f0a9afec..92d2c026d9 100644 --- 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 this. + * 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 this. * 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. diff --git a/packages/core/src/plugins/default/markbind-plugin-plantuml.ts b/packages/core/src/plugins/default/markbind-plugin-plantuml.ts index 5b709af4e0..9406be9b6a 100644 --- 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!');