Skip to content

Commit

Permalink
mention remark-emoji in breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
slorber committed Oct 26, 2023
1 parent 44837bf commit 987c78a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,7 @@ serializers
setaf
setext
shiki
shortcodes
showinfo
sida
simen
Expand Down
13 changes: 13 additions & 0 deletions website/docs/migration/v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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+.
Expand Down

0 comments on commit 987c78a

Please sign in to comment.