CodeRay

CodeRay 是一个支持以下语言的、感知编码的语法高亮器。

C

C++

Clojure

CSS

Delphi

diff

ERB

Go

Groovy

HAML

HTML

Java

JavaScript

JSON

Lua

PHP

Python

Ruby

Sass

SQL

Taskpaper

XML

YAML

安装 CodeRay

要将 CodeRay 与 Asciidoctor 一起使用,您需要 coderay gem。您可以使用以下任一方法安装 CodeRay。

使用 gem 安装(所有系统)
$ gem install coderay
使用 apt-get 安装(Debian 系统)
$ sudo apt-get install ruby-coderay
使用 dnf 安装(Fedora 系统)
$ sudo dnf install rubygem-coderay

激活 CodeRay

安装完 gem 后,在文档头部分配 coderay 值给 source-highlighter 属性即可激活它。

:source-highlighter: coderay

CodeRay 属性

您可以使用其他 CodeRay 属性进一步自定义源代码块的输出。

coderay-css

控制用于将 CSS 应用于 token 的方法。可以是 classstyle。默认值:class

coderay-linenums-mode

控制行号的布局方式。可以是 tableinline。如果在预格式化块(即 prewrap)中启用了行换行,并且您想对源代码块使用行号,则必须将此属性的值设置为 inline,以使行号与其目标行正确对齐。默认值:table

示例 1. 使用 CodeRay 行号自定义源代码块
:source-highlighter: coderay
:coderay-linenums-mode: inline

[%linenums,ruby]
----
ORDERED_LIST_KEYWORDS = {
  'loweralpha' => 'a',
  'lowerroman' => 'i',
  'upperalpha' => 'A',
  'upperroman' => 'I'
   #'lowergreek' => 'a'
   #'arabic'     => '1'
   #'decimal'    => '1'
}
----

有关 coderay-css 属性的信息,请参阅 CodeRay 样式表部分