Skip to content

[docs] feat: enable Material emoji icons in docs #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Wangmerlyn merged 2 commits into from
Nov 25, 2025
Merged

[docs] feat: enable Material emoji icons in docs #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e097360
Enable Material emoji icons in docs
Wangmerlyn Nov 12, 2025
7e5364b
Add attr_list extension for docs
Wangmerlyn Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ markdown_extensions:
- codehilite
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
Comment on lines +37 to +39

@gemini-code-assist gemini-code-assist Bot Nov 25, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This correctly enables emoji support. While you're modifying the markdown extensions, it's a good opportunity to also add attr_list. This extension is highly recommended by the mkdocs-material theme as it's used for several advanced features, such as adding custom attributes to Markdown elements for styling.

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

- attr_list