Skip to content

Commit 1263819

Browse files
josephtatestrangelookingnerd
authored andcommitted
restore example of how to use font-awesome (refixes #184)
1 parent 39df1e2 commit 1263819

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ image::images/badge.png[Badge,height="250",align="center"]
4141

4242
==== addBadge
4343

44-
This is the central pipeline step that allows users to add custom badges to their builds.
45-
A badge can either be an icon or text that can optionally be formatted as HTML rather than plain text.
46-
Users can also add links to the badges as well as styling to get the desired visual results.
44+
This is the central pipeline step that allows users to add custom badges to their builds. A badge can either be an icon
45+
or text that can optionally be formatted as HTML rather than plain text. Users can also add links to the badges as well
46+
as styling to get the desired visual results.
4747

4848
===== Examples
4949

50-
See https://www.jenkins.io/doc/pipeline/steps/badge/#addbadge-add-badge[Jenkins Pipeline Steps Reference] for detailed descriptions of the supported parameters.
50+
See https://www.jenkins.io/doc/pipeline/steps/badge/#addbadge-add-badge[Jenkins Pipeline Steps Reference] for detailed descriptions of the supported parameters, supported icon plugins, and styling options.
5151

5252
[source,groovy]
5353
----

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<li><code>addBadge icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'</code></li>
99
<li><code>addBadge icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'</code></li>
1010
<li><code>addBadge icon: 'symbol-emoji_sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'</code></li>
11+
<li><code>addBadge icon: 'symbol-solid/flag-checkered plugin-font-awesome-api', text: 'This is a checkered flag from font-awesome. Note the slash between the icon family and the name.</code></li>
1112
<li><code>addBadge icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'</code></li>
1213
<li><code>addBadge icon: 'icon-gear', text: 'This is a Jenkins Core icon'</code></li>
1314
</ul>

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
<li><code>addBadge icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'</code></li>
1616
<li><code>addBadge icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'</code></li>
1717
<li><code>addBadge icon: 'symbol-battery-half-sharp plugin-ionicons-api', text: 'This is a half filled battery symbol'</code></li>
18+
<li><code>addBadge icon: 'symbol-emoji_sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'</code></li>
19+
<li><code>addBadge icon: 'symbol-solid/flag-checkered plugin-font-awesome-api', text: 'This is a checkered flag from font-awesome. Note the slash between the icon family and the name.</code></li>
1820
<li><code>addBadge icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'</code></li>
1921
<li><code>addBadge icon: 'icon-gear', text: 'This is a Jenkins Core icon'</code></li>
2022
</ul>

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddSummaryStep/help-icon.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<li><code>addSummary icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'</code></li>
99
<li><code>addSummary icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'</code></li>
1010
<li><code>addSummary icon: 'symbol-emoji_sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'</code></li>
11+
<li><code>addSummary icon: 'symbol-solid/flag-checkered plugin-font-awesome-api', text: 'This is a checkered flag from font-awesome. Note the slash between the icon family and the name.</code></li>
1112
<li><code>addSummary icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'</code></li>
1213
<li><code>addSummary icon: 'icon-gear', text: 'This is a Jenkins Core icon'</code></li>
1314
</ul>

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddSummaryStep/help.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
<li><code>addSummary icon: 'symbol-alert-circle-outline plugin-ionicons-api', text: 'This is an alert symbol'</code></li>
1616
<li><code>addSummary icon: 'symbol-bar-chart-filled plugin-ionicons-api', text: 'This is a bar chart symbol'</code></li>
1717
<li><code>addSummary icon: 'symbol-battery-half-sharp plugin-ionicons-api', text: 'This is a half filled battery symbol'</code></li>
18+
<li><code>addSummary icon: 'symbol-emoji_sloth plugin-emoji-symbols-api', text: 'This is a sloth symbol'</code></li>
19+
<li><code>addSummary icon: 'symbol-solid/flag-checkered plugin-font-awesome-api', text: 'This is a checkered flag from font-awesome. Note the slash between the icon family and the name.</code></li>
1820
<li><code>addSummary icon: 'symbol-cube', text: 'This is a Jenkins Core symbol'</code></li>
1921
<li><code>addSummary icon: 'icon-gear', text: 'This is a Jenkins Core icon'</code></li>
2022
</ul>

0 commit comments

Comments
 (0)