Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glutanimate/syntax-highlighting

A fork of Tiago Barroso's Syntax Highlighting add-on with support for Anki 2.1
https://github.com/glutanimate/syntax-highlighting

anki anki-addon pygments syntax-highlighting

Last synced: about 1 month ago
JSON representation

A fork of Tiago Barroso's Syntax Highlighting add-on with support for Anki 2.1

Awesome Lists containing this project

README 

        



Syntax Highlighting for Anki























Allows you to insert syntax-highlighted code snippets into the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/).



### Table of Contents 



- [Installation](#installation)

- [Documentation](#documentation)

- [Building](#building)

- [Contributing](#contributing)

- [License and Credits](#license-and-credits)



### Installation



#### AnkiWeb 



The easiest way to install Syntax Highlighting is through [AnkiWeb](https://ankiweb.net/shared/info/1463041493).



#### Manual installation 



Please click on the entry corresponding to your Anki version:



Anki 2.1



1. Make sure you have the [latest version](https://apps.ankiweb.net/#download) 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](https://github.com/glutanimate/syntax-highlighting/releases) (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](https://github.com/glutanimate/syntax-highlighting/releases) (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](docs/description.md) for AnkiWeb.



### Building



With [Anki add-on builder](https://github.com/glutanimate/anki-addon-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](https://github.com/glutanimate/anki-addon-builder/#usage).



### Contributing



Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) 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](https://github.com/tmbb)*



*Copyright © 2015 [Tim Rae](https://github.com/timrae)*



*Copyright © 2018-2019 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*



*Syntax Highlighting* is based on [*Syntax Highlighting for Code*](https://github.com/tmbb/SyntaxHighlight) by [Tiago Barroso](https://github.com/tmbb). All credit for the original add-on goes to him. A major thanks is also due for [Tim Rae](https://github.com/timrae), 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](http://pygments.org/) 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](https://github.com/glutanimate/syntax-highlighting/blob/master/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 ❤️ !