mermaid icon indicating copy to clipboard operation
mermaid copied to clipboard

Documentation missing versions of supported Font Awesome icons

Open jpl-jengelke opened this issue 2 years ago • 3 comments

Describe the bug There's no list of which Font Awesome icons are supported. So Mermaid does not appear to display certain icons in current documentation (as of today's date, 18,000+ icons).

Mermaid actually supports an older version of FA with roughly 675 icons. To complicate the issue, FA appears to have deprecated its font codes in favor of a simpler syntax, e.g. getting rid of fa- prefixes. To further complicate the issue, Mermaid may be supporting an earlier release of version 4 since even some of those don't display.

The version of FA (version 4?) supported by Mermaid should be documented to reduce confusion and allow users to have a baseline on what they can use in their charts.

Expected behavior Documentation where the version of Font Awesome supported should be listed is currently at https://mermaid-js.github.io/mermaid/#/flowchart?id=basic-support-for-fontawesome .

Additional context There appears to be a lot of confusion about FA support. This documentation update may help clear up any questions and potentially reduce the number of tickets coming in about FA.

jpl-jengelke avatar Jul 08 '22 18:07 jpl-jengelke

I agree that this should be clarified. Perhaps as a part of a bigger icon overhaul. The tricky bit is backwards compatability. We cant break old working diagrams ...

knsv avatar Aug 20 '22 10:08 knsv

Can we get some traction on this?

walterrowe avatar Feb 08 '23 17:02 walterrowe

the mermaid docs reference v5 icons. i'm using gitlab 15.8. it only supports v4 icons. is that a gitlab or mermaid issue?

walterrowe avatar Feb 08 '23 19:02 walterrowe

@walterrowe Gitlab

jgreywolf avatar Apr 06 '23 14:04 jgreywolf

Closing as documentation does state what icons are supported (http://mermaid.js.org/syntax/flowchart.html#basic-support-for-fontawesome)

jgreywolf avatar Aug 28 '23 12:08 jgreywolf

Actually, what was meant is the issue was fixed sometime after the ticket was created but the ticket wasn't closed (until now).

BTW, there's a spelling error in the latest iteration --verion which should be version.

jpl-jengelke avatar Aug 28 '23 18:08 jpl-jengelke