diff --git a/CHANGES.md b/CHANGES.md index 1d5c99c3ee..ddd25c8741 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -25,6 +25,32 @@ Grammar improvements: - enh(dart) Fix empty block-comments from breaking highlighting (#2898) [Jan Pilzer][] - enh(dart) Fix empty doc-comment eating next line [Jan Pilzer][] +Deprecations (*these will be mentioned in every release*): + +- HTML "merging" is deprecated. (#2873) [Josh Goebel][] + - HTML inside `
` blocks will no longer be magically merged back into the + highlighted code's HTML result - it will instead be silently removed. + - Consider [using a plugin][htmlPlugin] if you truly need this functionality + - Deprecated as of 10.5.0 - will be removed in v11. +- `tabReplace` option deprecated. (#2873) [Josh Goebel][] + - **Consider:** Use the CSS `tab-size` property, or simply pre-process the + text yourself before rendering the initial HTML + - otherwise, [use a plugin][tabPlugin] + - Deprecated as of 10.5.0 - will be removed in v11. +- `useBR` option deprecated. (#2559) [Josh Goebel][] + - **Recommended:** You really should just use the HTML `` tag + - or perhaps try CSS `white-space: pre;` + - otherwise, [use a plugin][brPlugin] + - Deprecated as of 10.3.0 - will be removed in v11. +- `requireLanguage` API is deprecated, will be removed in v11.0. + - **Consider:** Use `getLanguage` (with custom error handling) or built-time dependencies. + - See [Library API](https://highlightjs.readthedocs.io/en/latest/api.html#requirelanguage-name) for more information. + - Deprecated as of 10.4.0 - will be removed in v11. + +[htmlPlugin]: https://github.com/highlightjs/highlight.js/issues/2889 +[tabPlugin]: https://github.com/highlightjs/highlight.js/issues/2874 +[brPlugin]: https://github.com/highlightjs/highlight.js/issues/2559 + [Jan Pilzer]: https://github.com/Hirse [Oldes Huhuman]: https://github.com/Oldes [Josh Goebel]: https://github.com/joshgoebel @@ -147,32 +173,6 @@ New themes: - *StackOverflow Dark* by [Jan Pilzer][] - *StackOverflow Light* by [Jan Pilzer][] - -Deprecations (*these will be mentioned in every release*): - -- HTML "merging" is deprecated. (#2873) [Josh Goebel][] - - HTML inside `` blocks will no longer be magically merged back into the - highlighted code's HTML result - it will instead be silently removed. - - Use a plugin if you truly need this functionality - - Deprecated as of 10.4.0 - will be removed in v11. -- `tabReplace` option deprecated. (#2873) [Josh Goebel][] - - **Consider:** Use the CSS `tab-size` property, or simply pre-process the - text yourself before rendering the initial HTML - - otherwise, [use a plugin][tabPlugin] - - Deprecated as of 10.4.0 - will be removed in v11. -- `useBR` option deprecated. (#2559) [Josh Goebel][] - - **Recommended:** You really should just use the HTML `` tag - - or perhaps try CSS `white-space: pre;` - - otherwise, [use a plugin][brPlugin] - - Deprecated as of 10.3.0 - will be removed in v11. -- `requireLanguage` API is deprecated, will be removed in v11.0. - - **Consider:** Use `getLanguage` (with custom error handling) or built-time dependencies. - - See [Library API](https://highlightjs.readthedocs.io/en/latest/api.html#requirelanguage-name) for more information. - - Deprecated as of 10.4.0 - will be removed in v11. - -[tabPlugin]: https://github.com/highlightjs/highlight.js/issues/2874 -[brPlugin]: https://github.com/highlightjs/highlight.js/issues/2559 - [Guillaume Grossetie]: https://github.com/mogztter [Brad Chamberlain]: https://github.com/bradcray [Marat Nagayev]: https://github.com/nagayev