Skip to content
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.

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

Replace "simple" emojis shortcodes #372

Merged
merged 2 commits into from
Jan 12, 2023
Merged

Replace "simple" emojis shortcodes #372

merged 2 commits into from
Jan 12, 2023

Conversation

JosephMarinier
Copy link
Contributor

Description:

Replace "simple" emojis shortcodes with actual emojis, as the shortcodes are broken
image
(even on mkdocs website, see https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#using-emojis)
image

I located them by searching for :(?!fontawesome-|material-|octicons-)[\w-]+: under /docs.

Checklist:

You should check all boxes before the PR is ready. If a box does not apply, check it to acknowledge it.

  • ISSUE NUMBER. You linked the issue number (Ex: Resolve #XXX).
  • PRE-COMMIT. You ran pre-commit on all commits, or else, you
    ran pre-commit run --all-files at the end.
  • USER CHANGES. The changes are added to CHANGELOG.md and the documentation, if they impact
    our users.
  • DEV CHANGES.
    • Update the documentation if this PR changes how to develop/launch on the app.
    • Update the README files and our wiki for any big design decisions, if relevant.
    • Add unit tests, docstrings, typing and comments for complex sections.

with actual emojis, as the shortcodes are broken (even on mkdocs website, see https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#using-emojis).

I located them by searching for `:(?!fontawesome-|material-|octicons-)[\w-]+:` under `/docs`.
Copy link
Contributor

@gabegma gabegma left a comment

Choose a reason for hiding this comment

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

Awesome! I noticed that too, but I was hoping it would be fixed soon, since I saw that it was not working on the mkdocs documentation too. Even better like that!

docs/docs/user-guide/index.md Outdated Show resolved Hide resolved
docs/docs/user-guide/index.md Outdated Show resolved Hide resolved
docs/docs/user-guide/index.md Outdated Show resolved Hide resolved
@JosephMarinier
Copy link
Contributor Author

@gabegma

I was hoping it would be fixed soon

The emojis were served by a third party maxcdn.com (not mkdocs-material). mkdocs-material released a patch 9.0.4 during the night. If we update mkdocs-material, it would fix our emojis shortcodes.

I say we make this fix anyway and we don't depend on those shortcodes. Makes sense?

@gabegma
Copy link
Contributor

gabegma commented Jan 12, 2023

Makes sense?

Ok with me!

@JosephMarinier JosephMarinier enabled auto-merge (squash) January 12, 2023 17:28
@JosephMarinier JosephMarinier merged commit 610617e into main Jan 12, 2023
@JosephMarinier JosephMarinier deleted the joseph/emojis branch January 12, 2023 17:44
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.

2 participants