Permalink
Browse files

Publish manual updates

  • Loading branch information...
dmlloyd committed Dec 3, 2017
1 parent 017c58e commit b085e1ac8ddb87108713fc5892765c68304e3e86
Showing with 8,390 additions and 39 deletions.
  1. +1,646 −0 manual/highlight/CHANGES.md
  2. +24 −0 manual/highlight/LICENSE
  3. +150 −0 manual/highlight/README.md
  4. +142 −0 manual/highlight/README.ru.md
  5. +2 −0 manual/highlight/highlight.min.js
  6. +108 −0 manual/highlight/styles/agate.css
  7. +66 −0 manual/highlight/styles/androidstudio.css
  8. +88 −0 manual/highlight/styles/arduino-light.css
  9. +73 −0 manual/highlight/styles/arta.css
  10. +45 −0 manual/highlight/styles/ascetic.css
  11. +83 −0 manual/highlight/styles/atelier-cave-dark.css
  12. +85 −0 manual/highlight/styles/atelier-cave-light.css
  13. +69 −0 manual/highlight/styles/atelier-dune-dark.css
  14. +69 −0 manual/highlight/styles/atelier-dune-light.css
  15. +84 −0 manual/highlight/styles/atelier-estuary-dark.css
  16. +84 −0 manual/highlight/styles/atelier-estuary-light.css
  17. +69 −0 manual/highlight/styles/atelier-forest-dark.css
  18. +69 −0 manual/highlight/styles/atelier-forest-light.css
  19. +69 −0 manual/highlight/styles/atelier-heath-dark.css
  20. +69 −0 manual/highlight/styles/atelier-heath-light.css
  21. +69 −0 manual/highlight/styles/atelier-lakeside-dark.css
  22. +69 −0 manual/highlight/styles/atelier-lakeside-light.css
  23. +84 −0 manual/highlight/styles/atelier-plateau-dark.css
  24. +84 −0 manual/highlight/styles/atelier-plateau-light.css
  25. +84 −0 manual/highlight/styles/atelier-savanna-dark.css
  26. +84 −0 manual/highlight/styles/atelier-savanna-light.css
  27. +69 −0 manual/highlight/styles/atelier-seaside-dark.css
  28. +69 −0 manual/highlight/styles/atelier-seaside-light.css
  29. +69 −0 manual/highlight/styles/atelier-sulphurpool-dark.css
  30. +69 −0 manual/highlight/styles/atelier-sulphurpool-light.css
  31. +96 −0 manual/highlight/styles/atom-one-dark.css
  32. +96 −0 manual/highlight/styles/atom-one-light.css
  33. +64 −0 manual/highlight/styles/brown-paper.css
  34. BIN manual/highlight/styles/brown-papersq.png
  35. +60 −0 manual/highlight/styles/codepen-embed.css
  36. +71 −0 manual/highlight/styles/color-brewer.css
  37. +77 −0 manual/highlight/styles/darcula.css
  38. +63 −0 manual/highlight/styles/dark.css
  39. +6 −0 manual/highlight/styles/darkula.css
  40. +99 −0 manual/highlight/styles/default.css
  41. +97 −0 manual/highlight/styles/docco.css
  42. +76 −0 manual/highlight/styles/dracula.css
  43. +71 −0 manual/highlight/styles/far.css
  44. +88 −0 manual/highlight/styles/foundation.css
  45. +71 −0 manual/highlight/styles/github-gist.css
  46. +99 −0 manual/highlight/styles/github.min.css
  47. +89 −0 manual/highlight/styles/googlecode.css
  48. +101 −0 manual/highlight/styles/grayscale.css
  49. +108 −0 manual/highlight/styles/gruvbox-dark.css
  50. +108 −0 manual/highlight/styles/gruvbox-light.css
  51. +83 −0 manual/highlight/styles/hopscotch.css
  52. +102 −0 manual/highlight/styles/hybrid.css
  53. +97 −0 manual/highlight/styles/idea.css
  54. +73 −0 manual/highlight/styles/ir-black.css
  55. +74 −0 manual/highlight/styles/kimbie.dark.css
  56. +74 −0 manual/highlight/styles/kimbie.light.css
  57. +70 −0 manual/highlight/styles/magula.css
  58. +59 −0 manual/highlight/styles/mono-blue.css
  59. +83 −0 manual/highlight/styles/monokai-sublime.css
  60. +70 −0 manual/highlight/styles/monokai.css
  61. +88 −0 manual/highlight/styles/obsidian.css
  62. +74 −0 manual/highlight/styles/ocean.css
  63. +72 −0 manual/highlight/styles/paraiso-dark.css
  64. +72 −0 manual/highlight/styles/paraiso-light.css
  65. +83 −0 manual/highlight/styles/pojoaque.css
  66. BIN manual/highlight/styles/pojoaque.jpg
  67. +96 −0 manual/highlight/styles/purebasic.css
  68. +83 −0 manual/highlight/styles/qtcreator_dark.css
  69. +83 −0 manual/highlight/styles/qtcreator_light.css
  70. +106 −0 manual/highlight/styles/railscasts.css
  71. +85 −0 manual/highlight/styles/rainbow.css
  72. +108 −0 manual/highlight/styles/routeros.css
  73. +72 −0 manual/highlight/styles/school-book.css
  74. BIN manual/highlight/styles/school-book.png
  75. +84 −0 manual/highlight/styles/solarized-dark.css
  76. +84 −0 manual/highlight/styles/solarized-light.css
  77. +102 −0 manual/highlight/styles/sunburst.css
  78. +75 −0 manual/highlight/styles/tomorrow-night-blue.css
  79. +74 −0 manual/highlight/styles/tomorrow-night-bright.css
  80. +74 −0 manual/highlight/styles/tomorrow-night-eighties.css
  81. +75 −0 manual/highlight/styles/tomorrow-night.css
  82. +72 −0 manual/highlight/styles/tomorrow.css
  83. +68 −0 manual/highlight/styles/vs.css
  84. +115 −0 manual/highlight/styles/vs2015.css
  85. +93 −0 manual/highlight/styles/xcode.css
  86. +92 −0 manual/highlight/styles/xt256.css
  87. +80 −0 manual/highlight/styles/zenburn.css
  88. +111 −39 manual/index.html
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -0,0 +1,24 @@
+Copyright (c) 2006, Ivan Sagalaev
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of highlight.js nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -0,0 +1,150 @@
+# Highlight.js
+
+[![Build Status](https://travis-ci.org/isagalaev/highlight.js.svg?branch=master)](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; it tries
+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][2]. 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`][3] and [`configure`][4]
+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`][4].
+
+
+## Web Workers
+
+You can run highlighting inside a web worker to avoid freezing the browser
+window while dealing with very big chunks of code.
+
+In your main script:
+
+```javascript
+addEventListener('load', function() {
+ var code = document.querySelector('#code');
+ var worker = new Worker('worker.js');
+ worker.onmessage = function(event) { code.innerHTML = event.data; }
+ worker.postMessage(code.textContent);
+})
+```
+
+In worker.js:
+
+```javascript
+onmessage = function(event) {
+ importScripts('<path>/highlight.pack.js');
+ var result = self.hljs.highlightAuto(event.data);
+ postMessage(result.value);
+}
+```
+
+
+## Getting the Library
+
+You can get highlight.js as a hosted, or custom-build, browser script or
+as a server module. Right out of the box the browser script supports
+both AMD and CommonJS, so if you wish you can use RequireJS or
+Browserify without having to build from source. The server module also
+works perfectly fine with Browserify, but there is the option to use a
+build specific to browsers rather than something meant for a server.
+Head over to the [download page][5] for all the options.
+
+**Don't link to GitHub directly.** The library is not supposed to work straight
+from the source, it requires building. If none of the pre-packaged options
+work for you refer to the [building documentation][6].
+
+**The CDN-hosted package doesn't have all the languages.** Otherwise it'd be
+too big. If you don't see the language you need in the ["Common" section][5],
+it can be added manually:
+
+```html
+<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.4.0/languages/go.min.js"></script>
+```
+
+**On Almond.** You need to use the optimizer to give the module a name. For
+example:
+
+```
+r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
+```
+
+
+## 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/>.
+
+Further in-depth documentation for the API and other topics is at
+<http://highlightjs.readthedocs.io/>.
+
+Authors and contributors are listed in the [AUTHORS.en.txt][8] file.
+
+[1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload
+[2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html
+[3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block
+[4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
+[5]: https://highlightjs.org/download/
+[6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
+[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
+[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt
@@ -0,0 +1,142 @@
+# Highlight.js
+
+Highlight.js — это инструмент для подсветки синтаксиса, написанный на JavaScript. Он работает
+и в браузере, и на сервере. Он работает с практически любой HTML разметкой, не
+зависит от каких-либо фреймворков и умеет автоматически определять язык.
+
+
+## Начало работы
+
+Минимум, что нужно сделать для использования highlight.js на веб-странице — это
+подключить библиотеку, CSS-стили и вызывать [`initHighlightingOnLoad`][1]:
+
+```html
+<link rel="stylesheet" href="/path/to/styles/default.css">
+<script src="/path/to/highlight.pack.js"></script>
+<script>hljs.initHighlightingOnLoad();</script>
+```
+
+Библиотека найдёт и раскрасит код внутри тегов `<pre><code>`, попытавшись
+автоматически определить язык. Когда автоопределение не срабатывает, можно явно
+указать язык в атрибуте class:
+
+```html
+<pre><code class="html">...</code></pre>
+```
+
+Список поддерживаемых классов языков доступен в [справочнике по классам][2].
+Класс также можно предварить префиксами `language-` или `lang-`.
+
+Чтобы отключить подсветку для какого-то блока, используйте класс `nohighlight`:
+
+```html
+<pre><code class="nohighlight">...</code></pre>
+```
+
+## Инициализация вручную
+
+Чтобы иметь чуть больше контроля за инициализацией подсветки, вы можете
+использовать функции [`highlightBlock`][3] и [`configure`][4]. Таким образом
+можно управлять тем, *что* и *когда* подсвечивать.
+
+Вот пример инициализации, эквивалентной вызову [`initHighlightingOnLoad`][1], но
+с использованием jQuery:
+
+```javascript
+$(document).ready(function() {
+ $('pre code').each(function(i, block) {
+ hljs.highlightBlock(block);
+ });
+});
+```
+
+Вы можете использовать любые теги разметки вместо `<pre><code>`. Если
+используете контейнер, не сохраняющий переводы строк, вам нужно сказать
+highlight.js использовать для них тег `<br>`:
+
+```javascript
+hljs.configure({useBR: true});
+
+$('div.code').each(function(i, block) {
+ hljs.highlightBlock(block);
+});
+```
+
+Другие опции можно найти в документации функции [`configure`][4].
+
+
+## Web Workers
+
+Подсветку можно запустить внутри web worker'а, чтобы окно
+браузера не подтормаживало при работе с большими кусками кода.
+
+В основном скрипте:
+
+```javascript
+addEventListener('load', function() {
+ var code = document.querySelector('#code');
+ var worker = new Worker('worker.js');
+ worker.onmessage = function(event) { code.innerHTML = event.data; }
+ worker.postMessage(code.textContent);
+})
+```
+
+В worker.js:
+
+```javascript
+onmessage = function(event) {
+ importScripts('<path>/highlight.pack.js');
+ var result = self.hljs.highlightAuto(event.data);
+ postMessage(result.value);
+}
+```
+
+
+## Установка библиотеки
+
+Highlight.js можно использовать в браузере прямо с CDN хостинга или скачать
+индивидуальную сборку, а также установив модуль на сервере. На
+[странице загрузки][5] подробно описаны все варианты.
+
+**Не подключайте GitHub напрямую.** Библиотека не предназначена для
+использования в виде исходного кода, а требует отдельной сборки. Если вам не
+подходит ни один из готовых вариантов, читайте [документацию по сборке][6].
+
+**Файл на CDN содержит не все языки.** Иначе он будет слишком большого размера.
+Если нужного вам языка нет в [категории "Common"][5], можно дообавить его
+вручную:
+
+```html
+<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.4.0/languages/go.min.js"></script>
+```
+
+**Про Almond.** Нужно задать имя модуля в оптимизаторе, например:
+
+```
+r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
+```
+
+
+## Лицензия
+
+Highlight.js распространяется под лицензией BSD. Подробнее читайте файл
+[LICENSE][7].
+
+
+## Ссылки
+
+Официальный сайт билиотеки расположен по адресу <https://highlightjs.org/>.
+
+Более подробная документация по API и другим темам расположена на
+<http://highlightjs.readthedocs.io/>.
+
+Авторы и контрибьюторы перечислены в файле [AUTHORS.ru.txt][8] file.
+
+[1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload
+[2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html
+[3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block
+[4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
+[5]: https://highlightjs.org/download/
+[6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
+[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
+[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.ru.txt

Large diffs are not rendered by default.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit b085e1a

Please sign in to comment.