nixpkgs-suyu/pkgs/misc/documentation-highlighter/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

48 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2018-03-27 03:06:42 +02:00
This file was generated with pkgs/misc/documentation-highlighter/update.sh
# Highlight.js CDN Assets
2018-03-27 03:06:42 +02:00
[![install size](https://packagephobia.now.sh/badge?p=highlight.js)](https://packagephobia.now.sh/result?p=highlight.js)
2018-03-27 03:06:42 +02:00
**This package contains only the CDN build assets of highlight.js.**
2018-03-27 03:06:42 +02:00
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.
2018-03-27 03:06:42 +02:00
To access these files via CDN:<br>
https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/
2018-03-27 03:06:42 +02:00
**If you just want a single .js file with the common languages built-in:
<https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/highlight.min.js>**
2018-03-27 03:06:42 +02:00
---
2018-03-27 03:06:42 +02:00
## Highlight.js
2018-03-27 03:06:42 +02:00
Highlight.js is a syntax highlighter written in JavaScript. It works in
the browser as well as on the server. It works with pretty much any
markup, doesnt depend on any framework, and has automatic language
detection.
2018-03-27 03:06:42 +02:00
If you'd like to read the full README:<br>
<https://github.com/highlightjs/highlight.js/blob/main/README.md>
2018-03-27 03:06:42 +02:00
## License
Highlight.js is released under the BSD License. See [LICENSE][7] file
for details.
## Links
The official site for the library is at <https://highlightjs.org/>.
The Github project may be found at: <https://github.com/highlightjs/highlight.js>
2018-03-27 03:06:42 +02:00
Further in-depth documentation for the API and other topics is at
<http://highlightjs.readthedocs.io/>.
A list of the Core Team and contributors can be found in the [CONTRIBUTORS.md][8] file.
2018-03-27 03:06:42 +02:00
[1]: https://www.npmjs.com/package/highlight.js
[7]: https://github.com/highlightjs/highlight.js/blob/main/LICENSE
[8]: https://github.com/highlightjs/highlight.js/blob/main/CONTRIBUTORS.md