Skip to content

Latest commit

 

History

History
116 lines (74 loc) · 5.53 KB

README.md

File metadata and controls

116 lines (74 loc) · 5.53 KB
Raw

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
  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 .ankiaddon packages.
  2. Download the latest .ankiaddon package from the releases tab (you might need to click on Assets below the description to reveal the download links)
  3. From Anki's main window, head to Tools → Add-ons
  4. Drag-and-drop the .ankiaddon package onto the add-ons list
  5. Restart Anki
Anki 2.0
  1. Go to Tools → Add-ons → Open add-ons folder
  2. Find and delete the Syntax Highlighting.py file if it already exists.
  3. See if you can find a syntax_highlighting folder. If so:
    1. If the folder contains a meta.json file, copy the file to a safe location. This will allow you to preserve your current settings.
    2. Proceed to delete the syntax_highlighting folder
  4. 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)
  5. Move the extracted Syntax Highlighting.py and syntax_highlighting into the add-ons folder
  6. Optional: Place the meta.json file back into the directory if you created a copy beforehand.
  7. 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.

The continued development of this add-on is made possible
thanks to my Patreon and Ko-Fi supporters.
You guys rock ❤️ !