diff --git a/CHANGES.md b/CHANGES.md index 38d7eb39b1..151b287984 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,6 +2,8 @@ **This is a major release.** As such it contains breaking changes which may require action from users. Please read [VERSION_11_UPGRADE.md](https://github.com/highlightjs/highlight.js/blob/main/VERSION_11_UPGRADE.md) for a detailed summary of all breaking changes. +### Potentially breaking changes + Unless otherwise attributed items below are thanks to [Josh Goebel][] (ref: [#2558](https://github.com/highlightjs/highlight.js/issues/2558)). *The below list should only be considered to be a high-level summary.* @@ -37,10 +39,7 @@ Language Grammars: - Some language grammar files have been removed. - Some redundant language aliases have been removed. -[Josh Goebel]: https://github.com/joshgoebel - - -## Version next (maybe 10, maybe merged into 11?) +### Other changes Parser: @@ -100,6 +99,7 @@ Dev Improvements: [NullVoxPopuli]: https://github.com/NullVoxPopuli [Mike Watling]: https://github.com/Pickysaurus + ## Version 10.7.1 - fix(parser) Resolves issues with TypeScript types [Josh Goebel][] diff --git a/README.md b/README.md index 68b3af8582..7a8103b052 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,12 @@ detection. --- -#### Upgrading to Version 11 +#### Upgrading to Version 11 (currently in alpha) As always our major releases do contain breaking changes which may require action from users. Please read [VERSION_11_UPGRADE.md](https://github.com/highlightjs/highlight.js/blob/main/VERSION_11_UPGRADE.md) for a detailed summary of breaking changes and any actions you may need to take. +**Latest:** 11.0.0-alpha0 + #### Upgrading to Version 10 Please read [VERSION_10_UPGRADE.md](https://github.com/highlightjs/highlight.js/blob/main/VERSION_10_UPGRADE.md) for high-level summary of breaking changes and any actions you may need to take. See [VERSION_10_BREAKING_CHANGES.md](https://github.com/highlightjs/highlight.js/blob/main/VERSION_10_BREAKING_CHANGES.md) for a more detailed list and [CHANGES.md](https://github.com/highlightjs/highlight.js/blob/main/CHANGES.md) to learn what else is new. @@ -70,6 +72,8 @@ Please read [VERSION_10_UPGRADE.md](https://github.com/highlightjs/highlight.js/ Please see [SECURITY.md](https://github.com/highlightjs/highlight.js/blob/main/SECURITY.md) for support information. +--- + ## Basic Usage ### In the Browser