Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joshgoebel authored Jun 6, 2021
1 parent 7e73c93 commit 47245af
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,28 @@

This is the repository for the CDN release of Highlight.js that can be found on
[cdnjs][1], [jsDelivr][2], and [unpkg][3]. If you were looking for the main
repository, it is [located here][4]. If you simply need a pre-build copy of
our CDN assets, this is the repository you are looking for. All the files are in the `build` directory and you can copy over that directory to where
ever you need it.
repository, it is [located here][4]. If you simply need a pre-built copy of
our CDN assets, this is the repository you are looking for. All the files are
in the `build` directory and you can copy over that directory to where ever
you need it.

### Fetching via NPM

This repository is also published to NPM as [@highlightjs/cdn-assets](https://www.npmjs.com/package/@highlightjs/cdn-assets).

### A note on the Git branches here

Note: The `main` branch here includes beta releases. If you're looking for
Note: The `main` branch here includes only beta releases. If you're looking for
the latest stable release code you want either one of the `stable` branches:

- [10-stable][10-stable] - The latest supported and maintained releases.
- [9-stable][9-stable] - The prior major version. ([you probably do not want this](https://github.com/highlightjs/highlight.js/blob/main/SECURITY.md))
- [11-stable][11-stable] - The latest supported and maintained release.
- [10-stable][10-stable] - The more recent prior major release.
- [9-stable][9-stable] - Verion 9.x. ([you probably do not want this](https://github.com/highlightjs/highlight.js/blob/main/SECURITY.md))

[1]: https://cdnjs.com/libraries/highlight.js
[2]: http://www.jsdelivr.com/#!highlight.js
[3]: https://unpkg.com/browse/@highlightjs/cdn-assets/
[4]: https://github.com/isagalaev/highlight.js
[11-stable]: https://github.com/highlightjs/cdn-release/tree/11-stable
[10-stable]: https://github.com/highlightjs/cdn-release/tree/10-stable
[9-stable]: https://github.com/highlightjs/cdn-release/tree/9-stable

0 comments on commit 47245af

Please sign in to comment.