| Index: highlight_js_8.3.0/README.md
|
| diff --git a/highlight_js_8.3.0/README.md b/highlight_js_8.3.0/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..8618022c898207bb2c4b248852d430657815961a
|
| --- /dev/null
|
| +++ b/highlight_js_8.3.0/README.md
|
| @@ -0,0 +1,101 @@
|
| +# Highlight.js
|
| +
|
| +[](https://travis-ci.org/isagalaev/highlight.js)
|
| +
|
| +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,
|
| +doesn't depend on any framework and has automatic language detection.
|
| +
|
| +
|
| +## Getting Started
|
| +
|
| +The bare minimum for using highlight.js on a web page is linking to the library
|
| +along with one of the styles and calling [`initHighlightingOnLoad`][1]:
|
| +
|
| +```html
|
| +<link rel="stylesheet" href="/path/to/styles/default.css">
|
| +<script src="/path/to/highlight.pack.js"></script>
|
| +<script>hljs.initHighlightingOnLoad();</script>
|
| +```
|
| +
|
| +This will find and highlight code inside of `<pre><code>` tags trying to detect
|
| +the language automatically. If automatic detection doesn't work for you, you can
|
| +specify the language in the class attribute:
|
| +
|
| +```html
|
| +<pre><code class="html">...</code></pre>
|
| +```
|
| +
|
| +The list of supported language classes is available in the [class reference][8].
|
| +Classes can also be prefixed with either `language-` or `lang-`.
|
| +
|
| +To disable highlighting altogether use the `nohighlight` class:
|
| +
|
| +```html
|
| +<pre><code class="nohighlight">...</code></pre>
|
| +```
|
| +
|
| +## Custom Initialization
|
| +
|
| +When you need a bit more control over the initialization of
|
| +highlight.js, you can use the [`highlightBlock`][2] and [`configure`][3]
|
| +functions. This allows you to control *what* to highlight and *when*.
|
| +
|
| +Here's an equivalent way to calling [`initHighlightingOnLoad`][1] using jQuery:
|
| +
|
| +```javascript
|
| +$(document).ready(function() {
|
| + $('pre code').each(function(i, block) {
|
| + hljs.highlightBlock(block);
|
| + });
|
| +});
|
| +```
|
| +
|
| +You can use any tags instead of `<pre><code>` to mark up your code. If you don't
|
| +use a container that preserve line breaks you will need to configure
|
| +highlight.js to use the `<br>` tag:
|
| +
|
| +```javascript
|
| +hljs.configure({useBR: true});
|
| +
|
| +$('div.code').each(function(i, block) {
|
| + hljs.highlightBlock(block);
|
| +});
|
| +```
|
| +
|
| +For other options refer to the documentation for [`configure`][3].
|
| +
|
| +
|
| +## Getting the Library
|
| +
|
| +You can get highlight.js as a hosted or custom-build browser script or as a
|
| +server module. Head over to the [download page][4] for all the options.
|
| +
|
| +Note, that the library is not supposed to work straight from the source on
|
| +GitHub, it requires building. If none of the pre-packaged options work for you
|
| +refer to the [building documentation][5].
|
| +
|
| +
|
| +## License
|
| +
|
| +Highlight.js is released under the BSD License. See [LICENSE][10] file for
|
| +details.
|
| +
|
| +
|
| +## Links
|
| +
|
| +The official site for the library is at <https://highlightjs.org/>.
|
| +
|
| +Further in-depth documentation for the API and other topics is at
|
| +<http://highlightjs.readthedocs.org/>.
|
| +
|
| +Authors and contributors are listed in the [AUTHORS.en.txt][9] file.
|
| +
|
| +[1]: http://highlightjs.readthedocs.org/en/latest/api.html#inithighlightingonload
|
| +[2]: http://highlightjs.readthedocs.org/en/latest/api.html#highlightblock-block
|
| +[3]: http://highlightjs.readthedocs.org/en/latest/api.html#configure-options
|
| +[4]: https://highlightjs.org/download/
|
| +[5]: http://highlightjs.readthedocs.org/en/latest/building-testing.html
|
| +[8]: http://highlightjs.readthedocs.org/en/latest/css-classes-reference.html
|
| +[9]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt
|
| +[10]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
|
|
|