From 90b11113826aff6beb44dc142849cf914174f8d0 Mon Sep 17 00:00:00 2001 From: jakobskrym Date: Sat, 30 Mar 2024 12:21:01 +0100 Subject: [PATCH] docs: update docs with new info --- docs/syntax/flowchart.md | 10 ++++++++++ packages/mermaid/src/docs/syntax/flowchart.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/syntax/flowchart.md b/docs/syntax/flowchart.md index 83676b0e4..e578af079 100644 --- a/docs/syntax/flowchart.md +++ b/docs/syntax/flowchart.md @@ -1178,6 +1178,16 @@ Adding this snippet in the `` would add support for Font Awesome v6.5.1 /> ``` +It is possible to use custom icons served from Font Awesome as long as the website imports the corresponding kit. Note that this is currently a paid feature from Font Awesome. + +For custom icons, you need to use the `fak` prefix. + +``` +flowchart TD + B["fa:fa-twitter for peace"] + B-->E(fak:fa-custom-icon-name) %% this will try to find your kit's custom icon +``` + ## Graph declarations with spaces between vertices and link and without semicolon - In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph. diff --git a/packages/mermaid/src/docs/syntax/flowchart.md b/packages/mermaid/src/docs/syntax/flowchart.md index 462a9aecc..571e75353 100644 --- a/packages/mermaid/src/docs/syntax/flowchart.md +++ b/packages/mermaid/src/docs/syntax/flowchart.md @@ -799,6 +799,16 @@ Adding this snippet in the `` would add support for Font Awesome v6.5.1 /> ``` +It is possible to use custom icons served from Font Awesome as long as the website imports the corresponding kit. Note that this is currently a paid feature from Font Awesome. + +For custom icons, you need to use the `fak` prefix. + +``` +flowchart TD + B["fa:fa-twitter for peace"] + B-->E(fak:fa-custom-icon-name) %% this will try to find your kit's custom icon +``` + ## Graph declarations with spaces between vertices and link and without semicolon - In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph.