https://github.com/glutanimate/highlight-search-results
Highlight Search Results in the Browser add-on for Anki
https://github.com/glutanimate/highlight-search-results
anki anki-addon education flashcards learning srs
Last synced: about 1 year ago
JSON representation
Highlight Search Results in the Browser add-on for Anki
- Host: GitHub
- URL: https://github.com/glutanimate/highlight-search-results
- Owner: glutanimate
- License: other
- Created: 2020-05-04T22:11:28.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T07:40:11.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T16:17:12.191Z (about 1 year ago)
- Topics: anki, anki-addon, education, flashcards, learning, srs
- Language: Python
- Homepage: https://ankiweb.net/shared/info/225180905
- Size: 345 KB
- Stars: 15
- Watchers: 3
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Highlight Search Results in the Browser for Anki
> The quickest way to find information on your flashcards
This is an add-on for the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/) that extends Anki's card browser with the ability to highlight search terms found in notes.
### Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Building](#building)
- [Contributing](#contributing)
- [License and Credits](#license-and-credits)
### Installation
#### AnkiWeb
The easiest way to install Highlight Search Results in the Browser is through [AnkiWeb](https://ankiweb.net/shared/info/225180905).
#### Manual installation
Please click on the entry corresponding to your Anki version:
Recent Anki 2.1 versions
*Note: These instructions only work on Anki 2.1.17 and up. For older Anki releases please see the next section.*
1. Download the latest `.ankiaddon` file from the [releases tab](https://github.com/glutanimate/highlight-search-results/releases) (you might need to click on *Assets* below the description to reveal the download links)
2. Open the folder where your downloads are located and double-click on the downloaded `.ankiaddon` file.
3. Follow the installation prompt and restart Anki if it asks you to
Older Anki 2.1 versions
1. Make sure you are [using at least Anki 2.1.10](https://apps.ankiweb.net/#download). 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/highlight-search-results/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
Video summary:
### 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/highlight-search-results.git
cd highlight-search-results
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
*Highlight Search Results in the Browser* is *Copyright © 2017-2020 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*
Highlight Search Results in the Browser 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/highlight-search-results/blob/master/LICENSE) file that accompanied this program.
Please note that this program uses the [Libaddon](https://github.com/glutanimate/anki-libaddon/) library which comes with [its own additional terms extending the GNU AGPLv3 license](https://github.com/glutanimate/anki-libaddon/blob/master/LICENSE). You may only copy, distribute, or modify the present compilation of this program with Libaddon under the combined licensing terms specified by both licenses.
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 ❤️ !