From 5f9b603bc6f5fdad69b584d8e0facd273f9cf637 Mon Sep 17 00:00:00 2001 From: Nicolas Vuillamy Date: Mon, 30 Dec 2024 17:11:32 +0100 Subject: [PATCH] MD warnings --- src/common/utils/flowVisualiser/flowParser.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/common/utils/flowVisualiser/flowParser.ts b/src/common/utils/flowVisualiser/flowParser.ts index 530211296..82d098a55 100644 --- a/src/common/utils/flowVisualiser/flowParser.ts +++ b/src/common/utils/flowVisualiser/flowParser.ts @@ -198,7 +198,10 @@ async function generateMermaidContent(flowMap: FlowMap, flowObj: any, options: a const currentBranch = await getCurrentGitBranch(); const footer = `\n\n___\n\n_Documentation generated from branch ${currentBranch} by [sfdx-hardis](${CONSTANTS.DOC_URL_ROOT}), featuring [salesforce-flow-visualiser](https://github.com/toddhalfpenny/salesforce-flow-visualiser)_`; const mdDiagram = - "%% If you read this, your Markdown visualizer does not handle MermaidJS syntax. If you are using sfdx-hardis, try to define env variable `MERMAID_MODES=cli,docker` ,then run again the command to regenerate markdown with SVG images.\n" + + "%% If you read this, your Markdown visualizer does not handle MermaidJS syntax.\n" + + "%% - If you are in VsCode, install extension `Markdown Preview Mermaid Support` at https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid\n" + + "%% - If you are using sfdx-hardis, try to define env variable `MERMAID_MODES=cli,docker` ,then run again the command to regenerate markdown with SVG images.\n" + + "%% - If you are within mkdocs-material, define mermaid plugin in `mkdocs.yml` as described in https://squidfunk.github.io/mkdocs-material/extensions/mermaid/\n\n" + "flowchart TB\n" + nodeDefStr + mdBody +