Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

MANUAL: more detail on customization in syntax highlighting section.

Browse source
This commit is contained in:
John MacFarlane 2018-08-11 16:31:35 -07:00
parent 49cfcc9c74
commit fb3ee947aa
1 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
MANUAL.txt
View file

@ -4624,9 +4624,9 @@ Syntax highlighting
Pandoc will automatically highlight syntax in [fenced code blocks] that Pandoc will automatically highlight syntax in [fenced code blocks] that
are marked with a language name. The Haskell library [skylighting] is are marked with a language name. The Haskell library [skylighting] is
used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output. used for highlighting. Currently highlighting is supported only for
To see a list of language names that pandoc will recognize, type HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names
`pandoc --list-highlight-languages`. that pandoc will recognize, type `pandoc --list-highlight-languages`.
The color scheme can be selected using the `--highlight-style` option. The color scheme can be selected using the `--highlight-style` option.
The default color scheme is `pygments`, which imitates the default color The default color scheme is `pygments`, which imitates the default color
@ -4634,6 +4634,24 @@ scheme used by the Python library pygments (though pygments is not actually
used to do the highlighting). To see a list of highlight styles, used to do the highlighting). To see a list of highlight styles,
type `pandoc --list-highlight-styles`. type `pandoc --list-highlight-styles`.
If you are not satisfied with the predefined styles, you can
use `--print-highlight-style` to generate a JSON `.theme` file which
can be modified and used as the argument to `--highlight-style`. To
get a JSON version of the `pygments` style, for example:
pandoc --print-highlight-style pygments > my.theme
Then edit `my.theme` and use it like this:
pandoc --highlight-style my.theme
If you are not satisfied with the built-in highlighting, or you
want highlight a language that isn't supported, you can use the
`--syntax-definition` option to load a [KDE-style XML syntax definition
file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
Before writing your own, have a look at KDE's [repository of syntax
definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
To disable highlighting, use the `--no-highlight` option. To disable highlighting, use the `--no-highlight` option.
[skylighting]: https://github.com/jgm/skylighting [skylighting]: https://github.com/jgm/skylighting