docs(readme): remove shiki compatibility section after updating rehype-pretty-code, shiki, and @shikijs/monaco to latest versions

This commit is contained in:
cfngc4594 2025-03-16 18:19:56 +08:00
parent 5da1629524
commit c40403a78f

View File

@ -158,21 +158,3 @@ For reference, you can see the content of the `.env.example` file.
- ❌ Missing syntax highlighting - ❌ Missing syntax highlighting
- ❌ No autocomplete suggestions - ❌ No autocomplete suggestions
- ❌ Silent LSP initialization failures - ❌ 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).