Skip to content

Commit

Permalink
Suggest documentation for syntax highlighting issues on Windows
Browse files Browse the repository at this point in the history
Suggest documentation to preemptively address user issues like #6704
  • Loading branch information
yakatz authored and jgm committed Sep 18, 2024
1 parent 56854c2 commit bac631f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions MANUAL.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
---byte-or

title: Pandoc User's Guide
author: John MacFarlane
date: September 9, 2024
Expand Down Expand Up @@ -7262,7 +7263,7 @@ 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
pandoc -o my.theme --print-highlight-style pygments

Then edit `my.theme` and use it like this:

Expand All @@ -7275,6 +7276,9 @@ file](https://docs.kde.org/stable5/en/kate/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).

If you receive an error that pandoc "Could not read highlighting theme",
check that the JSON file is encoded with UTF-8 and has no Byte-Order Mark (BOM).

To disable highlighting, use the `--no-highlight` option.

[skylighting]: https://github.com/jgm/skylighting
Expand Down

0 comments on commit bac631f

Please sign in to comment.