diff options
Diffstat (limited to 'documentation-highlighter/README.md')
-rw-r--r-- | documentation-highlighter/README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/documentation-highlighter/README.md b/documentation-highlighter/README.md new file mode 100644 index 0000000..569c90a --- /dev/null +++ b/documentation-highlighter/README.md | |||
@@ -0,0 +1,47 @@ | |||
1 | This file was generated with pkgs/misc/documentation-highlighter/update.sh | ||
2 | |||
3 | # Highlight.js CDN Assets | ||
4 | |||
5 | [](https://packagephobia.now.sh/result?p=highlight.js) | ||
6 | |||
7 | **This package contains only the CDN build assets of highlight.js.** | ||
8 | |||
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. | ||
10 | |||
11 | To access these files via CDN:<br> | ||
12 | https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/ | ||
13 | |||
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>** | ||
16 | |||
17 | --- | ||
18 | |||
19 | ## Highlight.js | ||
20 | |||
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. | ||
25 | |||
26 | If you'd like to read the full README:<br> | ||
27 | <https://github.com/highlightjs/highlight.js/blob/main/README.md> | ||
28 | |||
29 | ## License | ||
30 | |||
31 | Highlight.js is released under the BSD License. See [LICENSE][7] file | ||
32 | for details. | ||
33 | |||
34 | ## Links | ||
35 | |||
36 | The official site for the library is at <https://highlightjs.org/>. | ||
37 | |||
38 | The Github project may be found at: <https://github.com/highlightjs/highlight.js> | ||
39 | |||
40 | Further in-depth documentation for the API and other topics is at | ||
41 | <http://highlightjs.readthedocs.io/>. | ||
42 | |||
43 | A list of the Core Team and contributors can be found in the [CONTRIBUTORS.md][8] file. | ||
44 | |||
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 | ||