Skip to content

Commit

Permalink
MD warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
nvuillam committed Dec 30, 2024
1 parent 48724b0 commit 5f9b603
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/common/utils/flowVisualiser/flowParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 +
Expand Down

0 comments on commit 5f9b603

Please sign in to comment.