Skip to content

feat: enable emoji support in markdown#44

Merged
ShawnMcKee merged 1 commit intomasterfrom
fix/enable-emoji-support
Dec 7, 2025
Merged

feat: enable emoji support in markdown#44
ShawnMcKee merged 1 commit intomasterfrom
fix/enable-emoji-support

Conversation

@ShawnMcKee
Copy link
Contributor

Problem

The homepage uses emoji shortcodes (, , ) in the "Get Started" section, but they don't render as emojis on the deployed site at https://osg-htc.org/networking/

Solution

Add the pymdownx.emoji extension to mkdocs.yml with Material theme's Twemoji integration.

Changes

markdown_extensions:
  # ... existing extensions ...
  - pymdownx.emoji:
      emoji_index: cd /root/Git-Repositories/networking && git push -u origin fix/enable-emoji-supportpython/name:material.extensions.emoji.twemoji
      emoji_generator: cd /root/Git-Repositories/networking && git push -u origin fix/enable-emoji-supportpython/name:material.extensions.emoji.to_svg

This enables:

  • ✅ Emoji shortcode rendering (e.g., :rocket: → 🚀)
  • ✅ Consistent emoji appearance across all browsers
  • ✅ SVG-based rendering for crisp display at any size
  • ✅ Works with Material for MkDocs theme

Result

After merging, the homepage will properly display:

  • 🚀 Deploy perfSONAR
  • 🔧 Troubleshoot Network Issues
  • 🔭 Understand the System

Documentation

Add pymdownx.emoji extension to render emoji shortcodes like 🚀,
🔧, and 🔭 on the homepage and throughout the site.

Uses Material theme's Twemoji integration for consistent emoji rendering
across all browsers and platforms.
@ShawnMcKee ShawnMcKee merged commit 2ade3b3 into master Dec 7, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant