Skip to content

Commit

Permalink
docs: reference to the blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Mar 11, 2024
1 parent dd17cb3 commit 593a2ed
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ A beautiful syntax highlighter based on TextMate grammar, accurate and powerful.
[📚 **Documentation**](https://shiki.style)

> [!NOTE]
> You are viewing the **v1 branch**, which is a [major rewrite](https://github.com/shikijs/shiki/releases/tag/v1.0.0) from v0.x. Check out the [Migration Guide](https://shiki.style/guide/migrate#migrate-from-v0-14) if you are upgrading from v0.x.
> You are viewing the **v1 branch**, which is a [major rewrite](https://github.com/shikijs/shiki/releases/tag/v1.0.0) from v0.x. Check out the [Migration Guide](https://shiki.style/guide/migrate#migrate-from-v0-14) if you are upgrading.
>
> If you are looking for the v0.x code, check the [v0.x branch](https://github.com/shikijs/shiki/tree/v0).
> For legacy code, check the [v0.x branch](https://github.com/shikijs/shiki/tree/v0).
## License

Expand Down
3 changes: 3 additions & 0 deletions docs/guide/migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ outline: deep

The v1.0 release of Shiki is a major rewrite that we took the chance to revise every design decision we made in the past. We originally had a separate package name as [Shikiji](https://github.com/antfu/shikiji) to experiment with the new design, now it's merged back to Shiki as v1.0.

> [!TIP] Learn more
> Interested in the story behind v1.0? Check out this [blog post](https://nuxt.com/blog/shiki-v1) for more details.
## Migrate from v0.14

Compare to [`shiki@0.14.3`](https://github.com/shikijs/shiki/releases/tag/v0.14.3), the list of breaking changes are:
Expand Down

0 comments on commit 593a2ed

Please sign in to comment.