Skip to content

Commit d3aa27f

Browse files
committed
(chore) document support for older versions
1 parent bc7c2a1 commit d3aa27f

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

OLD_VERSIONS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Support for Older Versions
2+
3+
Due to both time and resource constrains the Highlight.js core team only fully supports the most current major version of the library. The prior major release will only receive critical security updates (when feasible).
4+
5+
| Version | Status | EOL |
6+
| :-----: | :------------ | :-: | - |
7+
| 10.x | *Current.* Regular updates; bug fixes & new features. | n/a |
8+
| 9.18.x | *Deprecated.* Security updates only. See [VERSION_10_UPGRADE.md](https://github.com/highlightjs/highlight.js/blob/master/VERSION_10_UPGRADE.md). | TBD |
9+
| < 9.17.x | Obsolete. | Jan 2020 |
10+
| 8.x | Obsolete. | |
11+
| 7.x | Obsolete. | |
12+
| Older | Obsolete. | |
13+
14+
Support for IE11 is really the only reason anyone should still prefer version 9. It's recommended that everyone else upgrade.

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,22 @@ the browser as well as on the server. It works with pretty much any
77
markup, doesn’t depend on any framework, and has automatic language
88
detection.
99

10-
## Upgrading from Version 9
10+
#### Upgrading to Version 10
1111

1212
Version 10 is one of the biggest releases in quite some time. If you're
1313
upgrading from version 9, there are some breaking changes and things you may
1414
want to double check first.
1515

1616
Please read [VERSION_10_UPGRADE.md](https://github.com/highlightjs/highlight.js/blob/master/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/master/VERSION_10_BREAKING_CHANGES.md) for a more detailed list and [CHANGES.md](https://github.com/highlightjs/highlight.js/blob/master/CHANGES.md) to learn what else is new.
1717

18+
##### Support for older versions
19+
20+
Please see [OLD_VERSIONS.md](https://github.com/highlightjs/highlight.js/blob/master/OLD_VERSIONS.md) for support information.
21+
1822
## Getting Started
1923

2024
The bare minimum for using highlight.js on a web page is linking to the
21-
library along with one of the styles and calling
22-
[`initHighlightingOnLoad`][1]:
25+
library along with one of the styles and calling [`initHighlightingOnLoad`][1]:
2326

2427
```html
2528
<link rel="stylesheet" href="/path/to/styles/default.css">

0 commit comments

Comments
 (0)