Skip to content

Icons & Emojis

DocsForge includes 8,000+ Material Design icons and 3,000+ Twemoji emojis.

Icons

Syntax

Use :material-icon-name: syntax:

:material-heart: I love DocsForge!

I love DocsForge!

Finding icons

Browse the Material Design Icons library. Common categories:

  • :material-home: —
  • :material-settings: — :material-settings:
  • :material-code-braces: —
  • :material-book-open: —
  • :material-github: —
  • :material-rocket-launch: —
  • :material-check-circle: —
  • :material-alert-circle: —

In admonitions

Icons appear automatically in admonition titles.

[Get started :material-arrow-right:](getting-started.md)

Get started

Sized icons

Apply CSS classes for sizing:

:material-heart:{ .lg } Large heart

Emojis

Use standard emoji shortcodes:

:smile: :thumbsup: :rocket: :fire: :star: :warning:

😄 👍 🚀 🔥 ⭐ ⚠

Font Awesome icons

Font Awesome brands are also available:

:fontawesome-brands-github: GitHub
:fontawesome-brands-python: Python
:fontawesome-brands-docker: Docker

GitHub
Python
Docker

Custom icons

Add your own icons in docs/assets/icons/:

extra:
  icon:
    logo: assets/logo.png

Icon in headers

## :material-rocket: Getting Started

Getting Started

Configuration

Icon support is enabled by default:

markdown_extensions:
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji

Next steps