Skip to content

Commit

Permalink
docs: note about package manager resolutions
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Jan 20, 2025
1 parent dd2991a commit 36f6737
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/blog/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,22 @@ import { enableDeprecationWarnings } from 'shiki/core'
enableDeprecationWarnings(false)
```

## Try It as a User

If you are using Shiki indirectly via other packages, like [`vitepress`](https://vitepress.dev/) or [`@nuxt/content`](https://content.nuxt.com/), etc. Where you don't directly control the version of Shiki, you can try adding the following lines to you `package.json` to force the usage of Shiki v2.0.0, and to check if the frameworks/tools you are using are using deprecated APIs of Shiki - if they do, report to their repositories and bring them the awareness of the upcoming changes. Thanks!

```json
{
"resolutions": {
"shiki": "^2",
"@shikijs/core": "^2",
"@shikijs/transformers": "^2",
"@shikijs/markdown-it": "^2",
"@shikijs/rehype": "^2"
}
}
```

## Feedback

Any feedbacks are welcome! Feel free to open an issue on [GitHub](https://github.com/shikijs/shiki) and let us know your thoughts.

0 comments on commit 36f6737

Please sign in to comment.