AnkiHub Addon Menu
The AnkiHub Addon menu can be found at the top of the screen on Anki. This is the central hub for all things AnkiHub!
Option 1: Create AnkiHub Deck
This button will allow the user to create a deck on AnkiHub. This deck can be either public or private. Once created, other subscribers can choose to subscribe to this deck.
To find out more about this button and deck creation, please refer to this section 🌎 Creating a Deck
Option 2: Deck Management
This button will allow the user to manage current deck subscriptions, browse new decks, unsubscribe, and configure other options related to deck settings
1. Browse Decks and Create AnkiHub Deck
- Browse decks will open Sign In where you can view all the decks AnkiHub has to offer
- Create AnkiHub deck will allow the user to create a new AnkiHub deck. (see more here: 🌎 Creating a Deck)
2. Subscribed AnkiHub decks
- This section will show all currently subscribed decks
3. Deck Name
- After selecting a deck that you are subscribed to, you can choose to either open it on AnkiHub or unsubscribe to the deck. Note, if you unsubscribe to the deck, this is not equivalent to deleting the deck.
To delete the deck, you must go to the deck on Anki → click on the settings icon next to the deck → click delete
4. Deck Options
Suspend new cards of existing notes
- Will automatically suspend the cards of existing notes in the deck in future updates based on your preference
Always = New cards of existing notes will always be suspended (i.e. if a pre-existing card with 2 clozes gets a new cloze added, this will automatically suspend the new cloze)
Never = New cards of existing notes will never be suspended (i.e. if a pre-existing card with 2 clozes gets a new cloze added, this will never suspend the new cloze → it will be unsuspended)
If siblings are unsuspended = New cards of existing notes will only be unsuspended if you have unsuspended that card
Scenario 1: If you have unsuspended a card that has two clozes and a deck creator/maintainer adds a new cloze to that card, this option will keep the new card unsuspended
Scenario 2: If a card you have suspended (not done before/decided to suspend) gets updated with a new cloze, this will keep the new cloze suspended (you will not see this card unless you specifically unsuspend it)
Suspend new cards of new notes
This option, when checked, will suspend new cards that get added to the deck that were not previously in the deck. (This does not effect new cards of pre-existing notes)
Enable Subdecks
This will allow subdecks in order to organize the deck. This only applies to decks with AnkiHub_Subdeck tags
Please see this section for more information on Subdecks 8 - 🧪 Advanced Functionality
Destination for New cards
This will select the deck you want new cards to be added to
Option 3: Sync with AnkiHub
This will sync all subscribed decks to AnkiHub
Option 4: Media Sync
This will display the status of the media sync
Idle: No media is being uploaded or downloaded
Downloading: Media is being downloaded (this may take time depending on your Internet speed)
Uploading: Media is being uploaded (do not close out of Anki or images will not appear properly on AnkiHub when this process is occurring)
See more about media sync here: 📸 Importing/Exporting Media
Option 5: Import Media
This option will allow you to import media to cards you currently have on Anki
See more info here: 📸 Importing/Exporting Media
Option 6: Upload Media for Deck
This feature can only be used by deck creators. This will allow the user to upload media to a deck they have created on AnkiHub
Option 7: Sign Out
This will sign you out of the addon. Syncing will no longer work. You will have to sign back in to use AnkiHub’s features
Option 8: Configuration
You can view the add-on configuration options by going to Ankihub addon -> Config -> Advanced. Below is a list of the current options and their descriptions. The average user won’t need to worry about these.
auto_sync
Option for controlling when or if the add-on automatically syncs with AnkiHub.
Options:
on_ankiweb_sync(default)on_startup(Will sync to AnkiHub only when starting up Anki)never(Will never sync automatically. Requires to be logged into AnkiWeb.)
debug_level_logs
Option for controlling whether to log debug level logs.
Options:
false(default)true
hotkey
Keyboard shortcut used to send a suggestion from the editor dialogue.
Option
- Default:
Alt+u
report_errors
Whether or not to report errors to the AnkiHub team.
Options:
true(default)false
suspend_new_cards_of_existing_notes
Option for deciding whether or not to suspend new cards of existing notes when syncing with AnkiHub.
Options:
if_siblings_are_suspended(default)never(Will never suspend new cards that are added to existing notes)always(Will always suspend new cards that are added to existing notes)
sync_hotkey
Keyboard shortcut used for syncing with AnkiHub.
Option:
- Default:
Ctrl+Shift+h
use_staging
Connect to the AnkiHub staging server instead of production. Used for testing the add-on.
Options:
False(default)True
Option 10: Help
Instructions & Changelog
This option will bring you to the AnkiHub documentation https://docs.ankihub.net/
Note: This website is being deprecated and will soon no longer be available.
Get Help
This option will redirect you to 🙋 Support - AnkiHub Community
You can expect to get a response from our support team within 24-48 hours!
Upload Logs
This option should be used when an AnkiHub developer asks you to upload logs to further diagnose an issue you are experiencing.
This will upload the AnkiHub addon’s logs to AnkiHub to go along a bug report. This may take a while
Upload Logs and Data
This option should be used when an AnkiHub developer asks you to upload logs and data to further diagnose an issue you are experiencing.
This will upload the AnkiHub addon’s logs and data to AnkiHub to go along a bug report. This may take a while
Downgrade from Add-on Beta Version
This will downgrade your AnkiHub addon from a beta version to a pre-existing public version.
This dialog will be revealed when pressed
