search

squidfunk / mkdocs-material

Documentation that simply works
https://squidfunk.github.io/mkdocs-material/
MIT License
20.11k stars 3.47k forks source link

Documentation clarification: Emoji use requires material theme #2707

Closed b-trav closed 3 years ago

b-trav commented 3 years ago

I want to suggest an idea and checked that ...

Firstly, let me say, I think MkDocs and mkdocs-material are fantastic! Thanks for such a useful product.

Description

Not sure if this is a feature request or a bug in the documentation. I am suggesting some clarification in your documentation. I followed the instructions in https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#emoji to get emoji working in MkDocs. The emoji appeared on the screen, but were HUGE. The reason for this was that I was not using the material theme (so there was no rules about twemoji in the stylesheets). It was not obvious to me that you MUST be using the material theme in MkDocs to use emoji, so mentioning that might save others the time I spent trouble-shooting,

If you think this is obvious, then please feel free to ignore this feature request.

facelessuser commented 3 years ago

It was not obvious to me that you MUST be using the material theme in MkDocs to use emoji, so mentioning that might save others the time I spent trouble-shooting,

  1. You do not need to use Material to use the Emoji extension. It doesn't care what MkDocs theme you use, nor is it an extension specific to MkDocs.
  2. While the Emoji extension can be used by anyone, it does not inject CSS into your HTML results, you must add sufficient CSS, usually restraining the size is enough.
  3. While emoji are supported, the icons that Material provides, which are exposed via the emoji extension (octicons, material, and etc.) are only available with the Material theme.
squidfunk commented 3 years ago

Thanks for reporting. The Material for MkDocs documentation only speaks for itself, not for other themes or extensions. Thus, I consider it obvious.