#
Octicons
Octicons can be used with the Icon component and several other components, including the Badge and Button.
#
Samples
#
Component
For the Icon component, the icon is specified using the syntax :icon-shortcode:, where shortcode is the name of the icon (found in the table below).
For example, use the code :icon-rocket: for a icon.
When an icon is used in other components, the icon is referred to by only the shortcode.
For example, the following demonstrates using the icon in a Badge and a Button.
#
Metadata
When an icon is specified within the Page or Project metadata, the icon can be referred to by only its shortcode.
The following sample demonstrates setting a Page icon to a .
---
icon: rocket
---
# Sample
This is a sample page with a :icon-rocket: icon.
#
New icons
The following NEW icons are included in Retype v3.12.0:
#
All icons
As of v3.12.0, there are 367 Octicons supported and more being added with each new release.
See also
Similar to a Button, the Badge component uses the same syntax as a hyperlink, but is prefixed with a
Similar to a Badge, the Button component uses the same syntax as a hyperlink, but is prefixed with a
The latest release of Retype is v3.12.0.
Retype Flavored Markdown(RFM) supports custom Components, including:
A static file download component can be configured by using the !file specifier in a link.
Similar to the Emoji:shortcode: syntax, you can add icons using :icon-shortcode:, where the shortcode
Individual .md pages can be configured using the Frontmatter metadata section added to the top of the page.
A special type of reference link can be configured by using the !ref specifier in a link.