fix(rehype)!: deprecate and disable highlightLines option

antfu · Jan 14, 2024 · fe0e4cb · fe0e4cb
1 parent 21e9955
commit fe0e4cb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/packages/rehype.md b/docs/packages/rehype.md
@@ -83,6 +83,10 @@ const file = await unified()
 
 ### Line Highlight
 
+::: note
+This is deprecated. It's disabled by default in `v0.10.0` and will be removed in the next minor. Consider use [`transformerNotationHighlight`](https://shikiji.netlify.app/packages/transformers#transformernotationhighlight) instead.
+:::
+
 In addition to the features of `shikiji`, this plugin also supports line highlighting. You can specify line numbers to highlight after the language name in the format `{<line-numbers>}` - a comma separated list of `<line-number>`s, wrapped in curly braces. Each line number can be a single number (e.g. `{2}` highlights line 2 and `{1,4}` highlights lines 1 and 4) or a range (e.g. `{5-7}` highlights lines 1 through 7, and `{1-3,5-6}` highlights lines 1 through 3 and 5 through 6). For example:
 
 ````md

diff --git a/packages/rehype-shikiji/src/core.ts b/packages/rehype-shikiji/src/core.ts
@@ -16,7 +16,8 @@ export interface RehypeShikijiExtraOptions {
   /**
    * Add `highlighted` class to lines defined in after codeblock
    *
-   * @default true
+   * @deprecated Use [transformerNotationHighlight](https://shikiji.netlify.app/packages/transformers#transformernotationhighlight) instead
+   * @default false
    */
   highlightLines?: boolean | string
 
@@ -62,7 +63,7 @@ const rehypeShikijiFromHighlighter: Plugin<[HighlighterGeneric<any, any>, Rehype
   options,
 ) {
   const {
-    highlightLines = true,
+    highlightLines = false,
     addLanguageClass = false,
     parseMetaString,
     cache,