diff --git a/project-words.txt b/project-words.txt index fe0f21d97a2d..2649e2b342ce 100644 --- a/project-words.txt +++ b/project-words.txt @@ -325,6 +325,7 @@ serializers setaf setext shiki +shortcodes showinfo sida simen diff --git a/website/docs/migration/v3.mdx b/website/docs/migration/v3.mdx index a0306d0b2867..12dd4f043d8f 100644 --- a/website/docs/migration/v3.mdx +++ b/website/docs/migration/v3.mdx @@ -39,6 +39,7 @@ Docusaurus v3 now uses the following dependencies: - TypeScript v5.0+ - prism-react-renderer v2.0+ - react-live v4.0+ +- remark-emoji v4.0+ - mermaid v10.4+ :::warning Upgrading community plugins @@ -576,6 +577,18 @@ However, this is a new major library version containing breaking changes, and we ::: +### remark-emoji v4.0+ + +Docusaurus v3 upgrades [`prism-react-renderer`](https://github.com/rhysd/remark-emoji) to v4.0+. This library is to support `:emoji:` shortcuts in Markdown. + +:::info How to upgrade + +Most Docusaurus users have nothing to do. Users of emoji shortcodes should read the [changelog](https://github.com/rhysd/remark-emoji/blob/master/CHANGELOG.md) and double-check their emojis keep rendering as expected. + +> **Breaking Change** Update [node-emoji](https://www.npmjs.com/package/node-emoji) from v1 to v2. This change introduces support for many new emojis and removes old emoji short codes which are no longer valid on GitHub. + +::: + ### Mermaid v10.4+ For users of the `@docusaurus/theme-mermaid` package, Docusaurus v3 upgrades [`mermaid`](https://github.com/mermaid-js/mermaid) to v10.4+.