Syntax Highlighting for Anki
Allows you to insert syntax-highlighted code snippets into the spaced-repetition flashcard app Anki.
Table of Contents
Installation
AnkiWeb
The easiest way to install Syntax Highlighting is through AnkiWeb.
Manual installation
Please click on the entry corresponding to your Anki version:
Anki 2.1
- Make sure you have the latest version of Anki 2.1 installed. Earlier releases (e.g. found in various Linux distros) do not support
.ankiaddonpackages. - Download the latest
.ankiaddonpackage from the releases tab (you might need to click on Assets below the description to reveal the download links) - From Anki's main window, head to Tools → Add-ons
- Drag-and-drop the
.ankiaddonpackage onto the add-ons list - Restart Anki
Anki 2.0
- Go to Tools → Add-ons → Open add-ons folder
- Find and delete the
Syntax Highlighting.pyfile if it already exists. - See if you can find a
syntax_highlightingfolder. If so:- If the folder contains a
meta.jsonfile, copy the file to a safe location. This will allow you to preserve your current settings. - Proceed to delete the
syntax_highlightingfolder
- If the folder contains a
- Download and extract the latest Anki 2.0 add-on release from the releases tab (you might need to click on Assets below the description to reveal the download links)
- Move the extracted
Syntax Highlighting.pyandsyntax_highlightinginto the add-ons folder - Optional: Place the
meta.jsonfile back into the directory if you created a copy beforehand. - Restart Anki
Documentation
For further information on the use of this add-on please check out the description text for AnkiWeb.
Building
With Anki add-on builder installed:
git clone https://github.com/glutanimate/syntax-highlighting.git
cd syntax-highlighting
aab build
For more information on the build process please refer to aab's documentation.
Contributing
Contributions are welcome! Please review the contribution guidelines on how to:
- Report issues
- File pull requests
- Support the project as a non-developer
License and Credits
Syntax Highlighting is
Copyright © 2012-2015 Tiago Barroso
Copyright © 2015 Tim Rae
Copyright © 2018-2019 Aristotelis P. (Glutanimate)
Syntax Highlighting is based on Syntax Highlighting for Code by Tiago Barroso. All credit for the original add-on goes to him. A major thanks is also due for Tim Rae, who extended the original add-on with CSS support.
The present fork and update to Anki 2.1 was made possible through the generous support of a fellow Anki user who would like to remain anonymous.
Syntax Highlighting ships with the following third-party open-source software:
- Pygments v2.2.0. Copyright (c) 2006-2017 by the Pygments Team. Licensed under the BSD license.
Syntax Highlighting is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the LICENSE file that accompanied this program.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.