SynHi

SynHi highlights the syntax of program code in the note editor. It turns code into HTML with colors (generated by Pygments 2.17.2) and inserts the HTML into the field at the cursor position.

How to use it

1. In the editor toolbar, choose the language of the code in the language list (for example Java, Python, or SQL).
2. Select code in a field, or copy code to the clipboard.
3. Click the SynHi editor button, or press Alt+S. SynHi highlights the selected text, or the clipboard text when nothing is selected, and inserts the result at the cursor position.

SynHi remembers the last used language, and by default the last used language of each deck.

Tools > SynHi Options ... opens the options:

• Line numbers
• Center code fragments
• Use CSS classes (instead of inline colors)
• Default to last language used per deck

These options are stored in the collection.

The add-on configuration (config.json, which Anki's add-on manager shows with the help text of config.md) has these advanced options; a change takes effect after Anki is restarted:

• hotkey: the shortcut of the editor button. Default: Alt+s.
• limitToLangs: the languages in the language list. Every entry must be a Pygments lexer name. Default: ["Bash", "Go", "HTML", "Java", "JavaScript", "Python", "SQL"]. An empty list [] lists every language that Pygments knows.
• style: the Pygments style of the colors. Default: monokai.

Relation to Syntax Highlighting (NG)

SynHi is a modified version of the add-on "Syntax Highlighting (NG)" (566351439). In current Anki editors the language list of Syntax Highlighting (NG) has no effect: the editor page has a Content Security Policy that blocks inline event handlers, so every code block is highlighted as Python. In SynHi the language list works again under that Content Security Policy, and the chosen language and the options are saved.

Installing SynHi switches off Syntax Highlighting (NG) automatically (the SynHi manifest lists it as a conflicting add-on). On first use, SynHi copies the settings of Syntax Highlighting (NG) that are stored in the collection, without changing them.

Tested on Anki 26.9.2. The SynHi manifest sets the minimum Anki version to 26.9.2 (min_point_version 260902). SynHi adds its button and language list to the editor aqt.editor.Editor (in Anki 26.9.2 this is aqt.editor_legacy.Editor), not to aqt.editor.NewEditor.

Credits

SynHi is based on the work of the authors of Syntax Highlighting (NG) and its earlier versions:

• Tiago Barroso
• Tim Rae
• Glutanimate
• A. Cavallo

License

SynHi is licensed under the GNU Affero General Public License version 3 (GNU AGPLv3) with the Additional Terms in LICENSE.txt. The add-on package contains its complete source code. The notices of changes are in CHANGES-FORK.md and in the header of each changed file.

SynHi includes Pygments 2.17.2, which is licensed under the BSD 2-Clause license.