Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/retypeapp/retype
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffreymcgill committed May 3, 2022
2 parents 49330e5 + 6f02af2 commit d22f72f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions components/icon.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ icon: dot
---
# Icon

Similar to the [Emoji](emoji.md) `:shortcode:` syntax, you can add icons using `:icon-shortcode:`, where the `shortcode` is an [Octicon](https://octicons-primer.vercel.app/octicons/) icon name.
Similar to the [Emoji](emoji.md) `:shortcode:` syntax, you can add icons using `:icon-shortcode:`, where the `shortcode` is an [Octicon](https://primer.github.io/octicons/) icon name.

For example, to add the [`star`](https://octicons-primer.vercel.app/octicons/star-24) icon, use the `:icon-star:` icon shortcode. :icon-star:
For example, to add the [`star`](https://primer.github.io/octicons/star-24) icon, use the `:icon-star:` icon shortcode. :icon-star:

Icons can be added anywhere within your document, including paragraph text, headings, table content, [Panel](panel.md) component titles, [Alerts](alert.md), [code block](code-block.md) titles, etc. :icon-thumbsup:

Some icon shortcode names are made up of `two-or-more` words. For instance, the [`git-branch`](https://octicons-primer.vercel.app/octicons/git-branch-24) icon would be configured as `:icon-git-branch:`. :icon-git-branch:
Some icon shortcode names are made up of `two-or-more` words. For instance, the [`git-branch`](https://primer.github.io/octicons/git-branch-24) icon would be configured as `:icon-git-branch:`. :icon-git-branch:

!!! More icons :icon-heart:
In future releases of Retype, the plan is to support additional Icon packs and possibily even custom developer defined icon packs. [Let us know](https://github.com/retypeapp/retype/discussions) if you are interested!
Expand Down

0 comments on commit d22f72f

Please sign in to comment.