Icons

Jamdesk includes Font Awesome Pro, giving you access to thousands of icons for navigation, cards, callouts, and inline content. Both free and pro icons are available.

Using Icons in Components

Most components accept an icon prop with a Font Awesome icon name:

<Card title="Getting Started" icon="rocket" href="/quickstart">

  Learn how to set up your documentation site.

</Card>

Getting Started

Learn how to set up your documentation site.

Icons work in Cards, Accordions, Tabs, and navigation items.

The Icon Component

Use the <Icon> component to display icons inline with text:

<Icon icon="check" color="green" /> Task completed

Task completed

Icon Props

Prop	Type	Default	Description
`icon`	string	required	Font Awesome icon name
`color`	string	-	Named color (red, blue, green) or hex (#FF5733)
`size`	number	16	Size in pixels

Examples

<Icon icon="star" color="yellow" size={24} />
<Icon icon="circle-check" color="green" />
<Icon icon="triangle-exclamation" color="orange" />
<Icon icon="heart" color="#E91E63" size={20} />

Finding Icons

Browse the full icon library at fontawesome.com/icons. Search for what you need, then use the icon name in your docs.

When searching on Font Awesome's site, look for the icon name shown below the icon (e.g., "circle-check", "arrow-right"). Use that exact name in your docs.

Brand Icons

Technology and company logos are automatically detected and rendered correctly:

<Icon icon="github" size={24} />
<Icon icon="discord" size={24} />
<Icon icon="react" size={24} />
<Icon icon="python" size={24} />

Common brand icons include:

Category	Icons
Social	github, discord, twitter, linkedin, youtube, slack
Languages	python, react, vuejs, angular, node-js, php, java
Services	aws, docker, google, microsoft, stripe, shopify

Add icons to your navigation in docs.json:

title="docs.json"

{
  "navigation": {
    "anchors": [
      {
        "anchor": "Docs",
        "icon": "book-open",
        "groups": [...]
      },
      {
        "anchor": "API",
        "icon": "code",
        "groups": [...]
      }
    ]
  }
}

Free vs Pro Icons

Jamdesk includes Font Awesome Pro, which means:

7,000+ icons available (vs ~2,000 in the free version)
All free icons work without any changes
Pro-exclusive icons like duotone variants are included
Light and thin weight icons available

If you're migrating from another documentation platform that used Font Awesome Free, all your existing icons will continue to work.

What's Next?

Card Component

Create feature cards with icons

Accordion Component

Collapsible sections with icons