summaryrefslogtreecommitdiff
path: root/docs/modules/syntax-highlighting/pages/coderay.adoc
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2020-11-23 17:44:00 -0700
committerSarah White <graphitefriction@gmail.com>2020-12-08 14:32:53 -0700
commitf096ff14e7aa881d0bb797e481ae2b66daccdebd (patch)
treee27f3b1796a2841bb8bca52d4b3fefb60c2af342 /docs/modules/syntax-highlighting/pages/coderay.adoc
parent44d1d3c25d12b70b8346d4435461601d20b66839 (diff)
rename source-highlighters module to syntax-highlighting
Diffstat (limited to 'docs/modules/syntax-highlighting/pages/coderay.adoc')
-rw-r--r--docs/modules/syntax-highlighting/pages/coderay.adoc107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/modules/syntax-highlighting/pages/coderay.adoc b/docs/modules/syntax-highlighting/pages/coderay.adoc
new file mode 100644
index 00000000..c7b035a9
--- /dev/null
+++ b/docs/modules/syntax-highlighting/pages/coderay.adoc
@@ -0,0 +1,107 @@
+= CodeRay
+:url-coderay: http://coderay.rubychan.de/
+:url-coderay-gem: https://rubygems.org/gems/coderay
+
+{url-coderay}[CodeRay^] is an encoding-aware, syntax highlighter that supports the languages listed below.
+
+[%autowidth,cols="3*",grid=none,frame=none]
+|===
+| C
+| C++
+| Clojure
+
+| CSS
+| Delphi
+| diff
+
+| ERB
+| Go
+| Groovy
+
+| HAML
+| HTML
+| Java
+
+| JavaScript
+| JSON
+| Lua
+
+| PHP
+| Python
+| Ruby
+
+| Sass
+| SQL
+| Taskpaper
+
+| XML
+| YAML
+|
+|===
+
+== Install CodeRay
+
+To use CodeRay with Asciidoctor, you need the {url-coderay-gem}[coderay RubyGem^].
+You can use one of the following methods to install CodeRay.
+
+Install using gem (all systems)::
++
+ $ gem install coderay
+
+Install using apt-get (Debian-based systems)::
++
+ $ sudo apt-get install coderay
+
+Install using dnf (Fedora-based systems)::
++
+ $ sudo dnf install rubygem-coderay
+
+== Activate CodeRay
+
+Once you've installed the RubyGem, assign the `coderay` value to the `source-highlighter` attribute in the document header to activate it.
+
+[source]
+----
+:source-highlighter: coderay
+----
+
+== CodeRay attributes
+
+You can further customize the source block output with additional CodeRay attributes.
+
+coderay-css::
+Controls what method is used for applying CSS to the tokens.
+Can be `class` or `style`.
+Default: `class`.
+
+coderay-linenums-mode::
+Controls how line numbers are laid out.
+Can be `table` or `inline`.
+If line wrapping is enabled on preformatted blocks (i.e., `prewrap`), and you want to use line numbering on source blocks, you must set the value of this attribute to `inline` in order for the numbers to line up properly with their target lines.
+Default: `table`.
+
+.Customizing a source block with CodeRay line numbers
+[source]
+....
+:source-highlighter: coderay
+:coderay-linenums-mode: inline
+
+[source,ruby,linenums]
+----
+ORDERED_LIST_KEYWORDS = {
+ 'loweralpha' => 'a',
+ 'lowerroman' => 'i',
+ 'upperalpha' => 'A',
+ 'upperroman' => 'I'
+ #'lowergreek' => 'a'
+ #'arabic' => '1'
+ #'decimal' => '1'
+}
+----
+....
+
+See the xref:html-backend:source-highlighting-stylesheets.adoc#coderay[CodeRay stylesheet section] to learn about the `coderay-css` attribute.
+
+////
+Note: I'm not getting this to work. Need to come back and do some quality assurance.
+////