Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a font-awesome example #184

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Add a font-awesome example #184

merged 1 commit into from
Aug 28, 2024

Conversation

bguyl
Copy link
Contributor

@bguyl bguyl commented Aug 28, 2024

The Font Awesome API plugin use a folder structure and thus the symbol notation need a /

Some examples:

symbol-solid/video
symbol-brands/42-group
symbol-regular/address-book

As it's a different behavior than the Ionicons API plugin and that's not mentioned anywhere, adding at least one example could be beneficial.

@bguyl bguyl requested a review from a team as a code owner August 28, 2024 13:06
Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much! Nice addition.

@MarkEWaite MarkEWaite added the documentation Documentation improvements label Aug 28, 2024
@MarkEWaite MarkEWaite changed the title Add an example on how to use font-awesome in the documentation Add a font-awesome example Aug 28, 2024
@MarkEWaite MarkEWaite merged commit 55e3f5a into jenkinsci:master Aug 28, 2024
19 checks passed
@marslo
Copy link

marslo commented Dec 14, 2024

Thanks @bguyl for your tips. I'd like to know how to identify the "folder structure" of icons in font-awesome ?

For example, the icon square-binary, I've tried:

addSummary icon: 'symbol-solid/square-binary plugin-font-awesome-api', text: 'symbol-solid/square-binary plugin-font-awesome-api'
addSummary icon: 'symbol-regular/square-binary plugin-font-awesome-api', text: 'symbol-regular/square-binary plugin-font-awesome-api'

However, none of those shows appropriate:
image

@strangelookingnerd
Copy link
Contributor

strangelookingnerd commented Dec 18, 2024

Thanks @bguyl for your tips. I'd like to know how to identify the "folder structure" of icons in font-awesome ?

For example, the icon square-binary, I've tried:

addSummary icon: 'symbol-solid/square-binary plugin-font-awesome-api', text: 'symbol-solid/square-binary plugin-font-awesome-api'
addSummary icon: 'symbol-regular/square-binary plugin-font-awesome-api', text: 'symbol-regular/square-binary plugin-font-awesome-api'

I think your symbol naming pattern is correct - however this specific icon square-binary is not (yet) included in the latest release (6.6.0-2) of font-awesome-api-plugin.

See jenkinsci/font-awesome-api-plugin#297 as I think this will add the latest set of icons.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants