Skip to content

Icon

    Tip: Enter some keywords to find icons and emojis and click on the shortcode to copy it to your clipboard.

    Configuration

    将以下行添加到 mkdocs.yml :

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

    Material for MkDocs 捆绑了以下图标集:

    • – [Material Design]
    • – [FontAwesome]
    • – [Octicons]
    • – [Simple Icons]

    Usage

    Emoji

    Emoji
    :smile:
    
    可以在 Markdown 中集成表情符号,方法是将表情符号的短代码放在两个冒号之间。如果您使用的是 Twemoji (recommended),可以在 Emojipedia 上查找短代码:

    😄

    Icon

    启用 Emoji 后,可以通过引用主题捆绑的任何图标的有效路径来使用图标,类似于表情符号,这些图标位于 .icons 目录中,并将 / 替换为 - :

    Icon
    :fontawesome-regular-face-laugh-wink: