gomi

Gomi is a Python package used to store and manage Note Types for Anki in a git repository. At Ajatt-Tools, we store our note types here. Gomi provides a super user-friendly mechanism of importing and exporting note types, and everyone is welcome to add their templates to our collection by making a pull request.

Prerequisites

GNU/Linux

Install Python 3.12 or later if you haven't already.

Windows

Windows is not recommended because it is malware.

%LOCALAPPDATA%\Microsoft\WindowsApps\python3

python3 -m

Installation

Install gomi using pipx: pipx install gomi.

Usage

Make sure Anki is running, and you have AnkiConnect installed.

Clone AnkiNoteTypes and cd into it. If you have never cloned a repository before, you need to install git. If you have git installed, open your terminal and type the following commands.

git clone "https://github.com/Ajatt-Tools/AnkiNoteTypes.git"
cd AnkiNoteTypes

Importing

To import one of the available Note Types to Anki, run:

gomi import

Note: When using AJT Japanese, reopen the current profile to add the add-on's scripts to the note type after importing and after updating. Alternatively, open AJT Japanese's settings and press "Ok" ("Accept").

Updating

If you imported a note type from the AJATT collection before, it received an update, and you want to import the new version, run:

gomi update

Exporting

To export one of your Note Types, run:

gomi export

Then write a helpful readme and commit your changes:

git add templates media && git commit

After committing your template, please create a pull request.

Caveats

Although gomi supports note types that reference external CSS and JS files stored in the collection.media folder, for example, by using <script src="_script.js"></script> in a Front or Back template, or by using @import url("_styling.css"); in the Styling section, there are a few caveats to keep in mind.

• The filenames should begin with an underscore to prevent Anki from flagging them as unused.

• If you use AnkiWeb to sync your collection with other devices (like an Android phone), external files will only sync once. If you change your externally linked CSS or JS file, you'll need to rename it so that updates are sent to your other devices. However, referencing external fonts is acceptable because they typically need to be synced only once.

• Specifically, loading external JS files causes a slight flicker or lag whenever you flip a card. It is recommended that you use inline scripts instead:

  <script>
  // some code
  </script>