diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-05-05 18:35:29 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-05-05 18:37:56 -0600 |
| commit | fee0ecf1e6c8ced4acd5ad1e2808ada90c6a6472 (patch) | |
| tree | a04fb3e353d7a133684f2a3ee5277170bccbed80 /docs/modules | |
| parent | f0df473346a3619fbd4e1490c5992c0e97c304da (diff) | |
explain more clearly which syntax highlighters are supported; declare Rouge as the preferred choice [no ci]
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/ROOT/pages/syntax-highlighting.adoc | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/modules/ROOT/pages/syntax-highlighting.adoc b/docs/modules/ROOT/pages/syntax-highlighting.adoc index ad1854fb..568f468c 100644 --- a/docs/modules/ROOT/pages/syntax-highlighting.adoc +++ b/docs/modules/ROOT/pages/syntax-highlighting.adoc @@ -3,8 +3,13 @@ [#install] == Install a syntax highlighter -To syntax highlight source listings, you need to install Rouge, Pygments, or CodeRay. -Choose one (or more) of the following: +To add source highlighting to source blocks, you must have a suitable syntax highlighter installed. +Asciidoctor PDF performs source highlighting during conversion, which means you must use a build-time syntax highlighter. + +The build-time syntax highlighters that Asciidoctor PDF supports out of the box are Rouge, Pygments, and CodeRay. +Rouge is the preferred syntax highlighter. + +To install Rouge, Pygments, or CodeRay, run the corresponding gem command shown below. .Rouge $ gem install rouge @@ -15,6 +20,8 @@ Choose one (or more) of the following: .CodeRay $ gem install coderay +Alternately, you can declare the gem in your [.path]_Gemfile_ to manage it using Bundler. + [#activate] == Activate syntax highlighting |