anvil-editor: init at 0.4
[NixPkgs.git] / pkgs / misc / documentation-highlighter / README.md
blob569c90affed9e64a693a4ca49364adb6cb716f57
1 This file was generated with pkgs/misc/documentation-highlighter/update.sh
3 # Highlight.js CDN Assets
5 [![install size](https://packagephobia.now.sh/badge?p=highlight.js)](https://packagephobia.now.sh/result?p=highlight.js)
7 **This package contains only the CDN build assets of highlight.js.**
9 This may be what you want if you'd like to install the pre-built distributable highlight.js client-side assets via NPM. If you're wanting to use highlight.js mainly on the server-side you likely want the [highlight.js][1] package instead.
11 To access these files via CDN:<br>
12 https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/
14 **If you just want a single .js file with the common languages built-in:
15 <https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/highlight.min.js>**
17 ---
19 ## Highlight.js
21 Highlight.js is a syntax highlighter written in JavaScript. It works in
22 the browser as well as on the server. It works with pretty much any
23 markup, doesn’t depend on any framework, and has automatic language
24 detection.
26 If you'd like to read the full README:<br>
27 <https://github.com/highlightjs/highlight.js/blob/main/README.md>
29 ## License
31 Highlight.js is released under the BSD License. See [LICENSE][7] file
32 for details.
34 ## Links
36 The official site for the library is at <https://highlightjs.org/>.
38 The Github project may be found at: <https://github.com/highlightjs/highlight.js>
40 Further in-depth documentation for the API and other topics is at
41 <http://highlightjs.readthedocs.io/>.
43 A list of the Core Team and contributors can be found in the [CONTRIBUTORS.md][8] file.
45 [1]: https://www.npmjs.com/package/highlight.js
46 [7]: https://github.com/highlightjs/highlight.js/blob/main/LICENSE
47 [8]: https://github.com/highlightjs/highlight.js/blob/main/CONTRIBUTORS.md