From c40403a78fa79564815ab581d82161160e160f75 Mon Sep 17 00:00:00 2001 From: cfngc4594 Date: Sun, 16 Mar 2025 18:19:56 +0800 Subject: [PATCH] docs(readme): remove shiki compatibility section after updating rehype-pretty-code, shiki, and @shikijs/monaco to latest versions --- README.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/README.md b/README.md index aa1c300..c7efd19 100644 --- a/README.md +++ b/README.md @@ -158,21 +158,3 @@ For reference, you can see the content of the `.env.example` file. - ❌ Missing syntax highlighting - ❌ No autocomplete suggestions - ❌ Silent LSP initialization failures - -### 🎨 Shiki Compatibility Notice - -Syntax highlighting depends on `rehype-pretty-code`'s deprecated `getHighlighter` API from `shiki@legacy`. - -**Key Points**: - -- **Affected File:** `src/components/mdx-preview.tsx` -- **Dependency Chain:** `rehype-pretty-code` → `shiki@legacy` -- **Version Constraints**: - - ```sh - "shiki": "<=2.5.0" - "@shikijs/monaco": "<=2.5.0" - ``` - -**Maintenance Note**: -While `shiki@3.0.0+` introduces modern APIs (`createHighlighter`/`getSingletonHighlighter`), upgrading requires `rehype-pretty-code` updates. Track progress [here](https://github.com/atomiks/rehype-pretty-code).