Skip to content

Commit 70a000e

Browse files
Merge pull request #3 from jenkinsci/feature/prepare_initial_release
Prepare initial release
2 parents 1fe2ded + f97c8a1 commit 70a000e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[emoji-symbols-api-plugin]]
22
= Emoji Symbols API Plugin
3+
:toc: macro
4+
:toclevels: 3
5+
:toc-title:
36

47
image:https://ci.jenkins.io/job/Plugins/job/emoji-symbols-api-plugin/job/main/badge/icon[link="https://ci.jenkins.io/job/Plugins/job/emoji-symbols-api-plugin/job/main/"]
58
image:https://codecov.io/gh/jenkinsci/emoji-symbols-api-plugin/branch/main/graph/badge.svg[link="https://codecov.io/gh/jenkinsci/emoji-symbols-api-plugin"]
@@ -16,9 +19,11 @@ This plugin provides https://unicode.org/emoji/charts/full-emoji-list.html[Unico
1619
The SVG files bundled by the plugin render the Emojis as `text` rather than `path`.
1720
This allows emojis to be interpreted by the browser being used.
1821

22+
toc::[]
23+
1924
== Usage
2025

21-
The symbol names follow the pattern of `symbol-emoji_NAME plugin-emoji-symbols-api`.
26+
The symbol names follow the pattern of `symbol-emoji___NAME__ plugin-emoji-symbols-api`.
2227

2328
Helper methods such as `io.jenkins.plugins.emoji.symbols.Emojis.getIconClassName` are provided by the plugin for easier generation of symbol identifiers.
2429

0 commit comments

Comments
 (0)