AnKing-VIP / AnKing-Note-Types

https://www.ankingmed.com
GNU Affero General Public License v3.0
44 stars 20 forks source link

AnKing Note Types

For simplicity and ease-of-use, I have uploaded all of my note types here. This will allow for better tracking of changes and better tutorials.

How to Use These Note Types

To download a note type, find the latest version in the Releases tab

To learn how to use and customize a note type, watch this video. For written instructions, open the Note Types Folder. Each Folder has it's own README file that explains the note and it's features

To install the AnKing Note Types add-on, (allows for very easy and user-friendly customization) visit this page: https://ankiweb.net/shared/info/952691989

How to Update These Note Types

There are two methods to update if you already have any of these notes in your collection

Method 1 (Preferred)
  1. Download the AnKing Note Types (Easy Customization) add-on from AnkiWeb. Be sure to restart Anki after installing.
  2. Go to the AnKing->AnKing Note Types menu and then select Update Note Types in the dialog
Method 2
  1. Download the latest file from the Releases tab
  2. Install the Special Fields add-on (restart Anki after installing)
  3. Go to Tools->Special Fields
  4. Click the Update Settings button and then Save
  5. Import the downloaded file. This should update the note styling After importing, we recommended that you go back to Tools->Special Fields and click the Import Tags Settings button to prevent any future updates from altering note styling
Method 3

NOTE: This method is less preferred because updates may be in progress and incomplete.

  1. Locate the appropriate file in the Note Types Folder
  2. Copy the text from the file into the Front Template, Back Template and Styling of the note type
    • You can click the Copy Raw Content (box on top of a box) button in the top right to easily copy everything (it's just left of the pencil icon)

Thank You

Huge thank you to @BlueGreenMagick, @Kleinerpirat, @RisingOrange, u/Ankiphil, and u/holythesea who have helped significantly with the development of these notes over the last few years. Also thank you to u/passwordisnotaco who posted the initial version of the IO-one by one note type.

How to Use & Customize These Note Types

Features Used In These Note Types

All note types in this repo use many or all of the features listed below. Some will appear slightly different as they have been customized to work with each individual style. Features unique to a note type are listed in the README file of that note type within the Note Types Folder

TODO

Contributing

All files in /Note Types are generated from files in /src. DO NOT edit the files in /Note Types! We use ejs to reduce duplicate code across various note types.

To generate the files, Node.js needs to be installed, and npm added to PATH.

After editing the files in /src, run npm run build to generate the files. Always run npm run build before opening a Pull Request.

If you get a Permission denied message, you may need to run sudo chmod 755 ./build to make the /build file executable.

The json files for the note types (for example https://github.com/AnKingMed/AnKing-Note-Types/blob/master/Note%20Types/AnKing/AnKing.json) are how Anki stores models / note types internally. The scheme is described in the AnkiDroid wiki https://github.com/ankidroid/Anki-Android/wiki/Database-Structure#models-jsonobjects. The AnKing Notes Add-on combines such a json file with a front template, a back template and the styling information and loads the resulting note type into Anki.


If you like these, please consider donating to this project




Check out our Anki Mastery Course! (The source of funding for this project)