diff --git a/docs/syntax/flowchart.md b/docs/syntax/flowchart.md index e578af079..1dd9fc22e 100644 --- a/docs/syntax/flowchart.md +++ b/docs/syntax/flowchart.md @@ -1178,14 +1178,20 @@ 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. +### Custom icons + +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. +**Example** + ``` 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 + B[fa:fa-twitter] %% standard icon + B-->E(fak:fa-custom-icon-name) %% custom icon ``` ## Graph declarations with spaces between vertices and link and without semicolon diff --git a/packages/mermaid/src/docs/syntax/flowchart.md b/packages/mermaid/src/docs/syntax/flowchart.md index 571e75353..86f7446a5 100644 --- a/packages/mermaid/src/docs/syntax/flowchart.md +++ b/packages/mermaid/src/docs/syntax/flowchart.md @@ -799,14 +799,20 @@ 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. +### Custom icons + +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. +**Example** + ``` 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 + B[fa:fa-twitter] %% standard icon + B-->E(fak:fa-custom-icon-name) %% custom icon ``` ## Graph declarations with spaces between vertices and link and without semicolon