Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
/ Anki.NET Public

Create Anki decks and cards in C#

License

Notifications You must be signed in to change notification settings

lysrt/Anki.NET

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

216 Commits
216 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Anki.NET

NuGet NuGet

Create and export Anki collections, decks, notes and cards from your C# applications.

var noteType = new AnkiNoteType(
    name: "Basic",
    cardTypes: new[] {
        new AnkiCardType(
            Name: "Card 1",
            Ordinal: 0,
            QuestionFormat: "{{Front}}",
            AnswerFormat: "{{Front}}<hr id=\"answer\">{{Back}}"
        )
    },
    fieldNames: new[] { "Front", "Back" }
);

var collection = new AnkiCollection();

var noteTypeId = collection.CreateNoteType(noteType);
var deckId = collection.CreateDeck("My Anki Deck");

collection.CreateNote(deckId, noteTypeId, "Hello", "Bonjour");

await AnkiFileWriter.WriteToFileAsync("MyCollection.apkg", collection);

Acknowledgement

Anki.NET is a fork form the the archived AnkiSharp project from Clement-Jean. Thanks a lot for the hard work!

Usage

AnkiCollection

Start by creating an AnkiCollection. To add notes to the collection, you need a notes model (AnkiNoteType), you can pass in the constructor, like this. A note can correspond to one or several cards, if their model has several card tempates ('AnkiCardType').

var cardTypes = new[]
{
    new AnkiCardType(
        "Forwards",
        0,
        "{{Front}}<br/>{{hint:Help}}",
        "{{Front}}<hr id=\"answer\">{{Back}}"
    ),
    new AnkiCardType(
        "Backwards",
        1,
        "{{Back}}<br/>{{hint:Help}}",
        "{{Back}}<hr id=\"answer\">{{Front}}"
    )
};

var noteType = new AnkiNoteType(
    "Basic (With hints)",
    cardTypes,
    new[] { "Front", "Back", "Help" }
);
        
var collection = new AnkiCollection();
var noteTypeId = collection.CreateNoteType(noteType);

AnkiDeck

var collection = new AnkiCollection();

var deckId = collection.CreateDeck("French vocabulary");

bool deckExists = collection.TryGetDeckById(deckId, out var deck);

AnkiNote

With the above AnkiNoteType (which has two card types), each added note will generate 2 different cards.

collection.CreateNote(deckId, notetypeId, "Hello", "Bonjour", "");
collection.CreateNote(deckId, noteTypeId, "House", "Maison", "Starts with \"M\"");

Set CSS

var noteType = new AnkiNoteType(
    name: "Basic",
    cardTypes: cardTypes,
    fieldNames: names,
    css: @".card{
        color: red;
    }",
);

Read AnkiCollection from .apkg file

AnkiCollection collection = await AnkiFileReader.ReadFromFileAsync("collection.apkg");

Write AnkiCollection to .apkg file

var collection = new AnkiCollection();
await AnkiFileWriter.WriteToFileAsync("MyCollection.apkg", collection);

Resources

About

Create Anki decks and cards in C#

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.