Support Bootstrap icons #2494
Merged
Support Bootstrap icons #2494
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2494 +/- ##
==========================================
+ Coverage 51.02% 51.08% +0.06%
==========================================
Files 124 124
Lines 5372 5367 -5
Branches 1159 1155 -4
==========================================
+ Hits 2741 2742 +1
+ Misses 2341 2335 -6
Partials 290 290 ☔ View full report in Codecov by Sentry. |
|
Thanks for attempting this @yiwen101 |
package.json
Outdated
| @@ -1,7 +1,9 @@ | |||
| { | |||
| "name": "root", | |||
| "private": true, | |||
| "workspaces": ["packages/*"], | |||
| "workspaces": [ | |||
yucheng11122017
force-pushed
the
master
branch
2 times, most recently
from
cb84513 to
69ec838
Compare
kaixin-hc
approved these changes
Apr 6, 2024
| @@ -55,6 +55,12 @@ MarkBind currently supports Version 6 of Font Awesome (Free plan). For detailed | |||
| 1. You may also append `~class-name` to the end of the octicon name to add `class="class-name"` property to your Octicon (e.g. `:octicon-git-pull-request~icon-large-red:` will generate an Octicon of class *icon-large-red*). You may then add corresponding CSS to `{root}/_markbind/layouts/{layout-name}/styles.css` to customize the style of your Octicon. | |||
| 1. If your background is dark, you may use `:octiconlight-*:` to render the icon as white. | |||
|
|
|||
| ###### Using Bootstrap icons | |||
There was a problem hiding this comment.
- Lines 3-5 : can you also update in this PR? Version of bootstrap relied on + Maybe delete line 5, which seems too repetitive.
- I never noticed before how repetitive these instructions are. I wonder if there is a better way to streamline the instructions? Hmm. Maybe a tooltip or something to see some different example icons would be cool.
yucheng11122017
approved these changes
Apr 9, 2024
docs/userGuide/syntax/icons.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| ## Icons | |||
|
|
|||
| <small>%%Acknowledgement: Font Awesome icons are provided by [Font Awesome](https://fontawesome.com/) under their [free license](https://fontawesome.com/license), Glyphicons are provided by [Glyphicons](https://glyphicons.com/) via [Bootstrap 3](https://getbootstrap.com/docs/3.3/), [Octicons](https://octicons.github.com) are copyright of GitHub, and Material icons are provided by [Google Fonts](https://fonts.google.com/icons) via [`material-icons` by Ravindra Marella](https://www.npmjs.com/package/material-icons) under the [Apache license 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).%%</small> | |||
| <small>%%Acknowledgement: Font Awesome icons are provided by [Font Awesome](https://fontawesome.com/) under their [free license](https://fontawesome.com/license), Glyphicons are provided by [Glyphicons](https://glyphicons.com/) via [Bootstrap 3](https://getbootstrap.com/docs/3.3/). Bootstrap icons are designed by [@mdo](https://github.com/mdo), maintained by the [Bootstrap Team](https://github.com/orgs/twbs/people) and provided under MIT liscense. [Octicons](https://octicons.github.com) are copyright of GitHub, and Material icons are provided by [Google Fonts](https://fonts.google.com/icons) via [`material-icons` by Ravindra Marella](https://www.npmjs.com/package/material-icons) under the [Apache license 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).%%</small> | |||
|
|
|||
| MarkBind supports using Font Icons provided by Font Awesome, Glyphicons and GitHub's Octicons. | |||
There was a problem hiding this comment.
Suggested change
| MarkBind supports using Font Icons provided by Font Awesome, Glyphicons and GitHub's Octicons. | |
| MarkBind supports using Font Icons provided by Font Awesome, Glyphicons, GitHub's Octicons and Bootstrap icons. |
|
@yucheng11122017 Each PR must have a SEMVER impact label, please remember to label the PR properly. |
|
Feature in action https://nus-cs2103-ay2324s2.github.io/website/admin/tp-w9.html
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is the purpose of this pull request?
Overview of changes:
Support bootstrap icons #1977
Anything you'd like to highlight/discuss:
I need to upload the copy of bootstrap-icons to the expected folder to pass test (and in current code, the expected folder also contains the source code of all other icons supported) That is where the +50 000 comes from.
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Support Bootstrap icons
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):