OLD | NEW |
(Empty) | |
| 1 # Highlight.js |
| 2 |
| 3 Highlight.js — это подсветчик синтаксиса, написанный на JavaScript. Он работает |
| 4 и в браузере, и на сервере. Он работает с практически любой HTML разметкой, не |
| 5 зависит от каких-либо фреймворков и умеет автоматически определять язык. |
| 6 |
| 7 |
| 8 ## Начало работы |
| 9 |
| 10 Минимум, что нужно сделать для использования highlight.js на веб-странице — это |
| 11 подключить библиотеку, CSS-стили и вызывать [`initHighlightingOnLoad`][1]: |
| 12 |
| 13 ```html |
| 14 <link rel="stylesheet" href="/path/to/styles/default.css"> |
| 15 <script src="/path/to/highlight.pack.js"></script> |
| 16 <script>hljs.initHighlightingOnLoad();</script> |
| 17 ``` |
| 18 |
| 19 Библиотека найдёт и раскрасит код внутри тегов `<pre><code>`, попытавшись |
| 20 автоматически определить язык. Когда автоопределение не срабатывает, можно явно |
| 21 указать язык в атрибуте class: |
| 22 |
| 23 ```html |
| 24 <pre><code class="html">...</code></pre> |
| 25 ``` |
| 26 |
| 27 Список поддерживаемых классов языков доступен в [справочнике по классам][8]. |
| 28 Класс также можно предваоить префиксами `language-` или `lang-`. |
| 29 |
| 30 Чтобы отключить подсветку для какого-то блока, используйте класс `nohighlight`: |
| 31 |
| 32 ```html |
| 33 <pre><code class="nohighlight">...</code></pre> |
| 34 ``` |
| 35 |
| 36 ## Инициализация вручную |
| 37 |
| 38 Чтобы иметь чуть больше контроля за инициализацией подсветки, вы можете |
| 39 использовать функции [`highlightBlock`][2] и [`configure`][3]. Таким образом |
| 40 можно управлять тем, *что* подсвечивать и *когда*. |
| 41 |
| 42 Вот пример инициализация, эквивалентной вызову [`initHighlightingOnLoad`][1], но |
| 43 с использованием jQuery: |
| 44 |
| 45 ```javascript |
| 46 $(document).ready(function() { |
| 47 $('pre code').each(function(i, block) { |
| 48 hljs.highlightBlock(block); |
| 49 }); |
| 50 }); |
| 51 ``` |
| 52 |
| 53 Вы можете использовать любые теги разметки вместо `<pre><code>`. Если |
| 54 используете контейнер, не сохраняющий переводы строк, вам нужно сказать |
| 55 highlight.js использовать для них тег `<br>`: |
| 56 |
| 57 ```javascript |
| 58 hljs.configure({useBR: true}); |
| 59 |
| 60 $('div.code').each(function(i, block) { |
| 61 hljs.highlightBlock(block); |
| 62 }); |
| 63 ``` |
| 64 |
| 65 Другие опции можно найти в документации функции [`configure`][3]. |
| 66 |
| 67 |
| 68 ## Установка библиотеки |
| 69 |
| 70 Highlight.js можно использовать в браузере прямо с CDN хостинга или скачать |
| 71 индивидуальную сборку, а также установив модуль на сервере. На |
| 72 [страница загрузки][4] подробно описаны все варианты. |
| 73 |
| 74 Обратите внимание, что библиотека не предназначена для использования в виде |
| 75 исходного кода на GitHub, а требует отдельной сборки. Если вам не подходит ни |
| 76 один из готовых вариантов, читайте [документацию по сборке][5]. |
| 77 |
| 78 |
| 79 ## Лицензия |
| 80 |
| 81 Highlight.js распространяется под лицензией BSD. Подробнее читайте файл |
| 82 [LICENSE][10]. |
| 83 |
| 84 |
| 85 ## Ссылки |
| 86 |
| 87 Официальный сайт билиотеки расположен по адресу <https://highlightjs.org/>. |
| 88 |
| 89 Более подробная документация по API и другим темам расположена на |
| 90 <http://highlightjs.readthedocs.org/>. |
| 91 |
| 92 Авторы и контрибьютора перечислена в файле [AUTHORS.ru.txt][9] file. |
| 93 |
| 94 [1]: http://highlightjs.readthedocs.org/en/latest/api.html#inithighlightingonloa
d |
| 95 [2]: http://highlightjs.readthedocs.org/en/latest/api.html#highlightblock-block |
| 96 [3]: http://highlightjs.readthedocs.org/en/latest/api.html#configure-options |
| 97 [4]: https://highlightjs.org/download/ |
| 98 [5]: http://highlightjs.readthedocs.org/en/latest/building-testing.html |
| 99 [8]: http://highlightjs.readthedocs.org/en/latest/css-classes-reference.html |
| 100 [9]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.ru.txt |
| 101 [10]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE |
OLD | NEW |