fix: add font-awesome css to docsify index.html #3271
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
馃搼 Summary
Because docsify
index.html
does not have font-awesome CSS file setup yet. Thus, Docsify can not render the font-awesome icon in any example pages.This PR is adding
font-awesome.min.css
in version 5.9.0 and also adding statement to the document that Mermaid now only support font-awesome version 4 and 5 only. The reason explained on 馃搹 Design DecisionsResolves #3190
馃搹 Design Decisions
This PR is adding
font-awesome.min.css
in version 5.9.0 (Latest Version: 6.1.2) because Mermaid's font-awesome seems supported only old syntax.For example,
fa-brands
prefix instead offab
, such as<i class="fa-brands fa-twitter"></i>
fa-solid
as well, such as<i class="fa-solid fa-car"></i>
We should update the font-awesome extractor to support the version 6 as well.
But it should not included in this PR as it out of scope of the issue. We need to update regex to extract the right
fa
class and write a unit test to make sure every versions (v4, v5, and v6) are working properly.馃搵 Tasks
Make sure you
develop
branch馃毃 The unit test fail because of latest commit on
develop
branch. 8681e78