Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 2.8 KB

Tutorial.md

File metadata and controls

105 lines (72 loc) · 2.8 KB
Raw

Introduction

Obsidian Anki Sync uses HTML (or, if you prefer to say XML) like syntax to make flashcards.

If you know HTML, you would recall, html code consists of elements. Similarly, we have blocks.

We can declare them as:

<!-- basicblock-start -->
What is formula for sin theta?::
$$\frac{Opposite}{Hypotenuse}$$
![Triangle](https://i.pinimg.com/originals/0d/79/3a/0d793a88f6c69aa8efd54a1012722c12.gif)
<!-- basicblock-end -->

This would generate this card:

Cards

Easy as that! 😀

Attributes on a block basis

Each such block can have attributes or options that override the default behavior.

For example, by default the cards will be generated in Default::ObsidianAnkiSync deck, but but using the deck attribute we can override it to something else. For this example, we are going to override it to deck Math.

<!-- basicblock-start deck='Math' -->
What is formula for sin theta?::
$$\frac{Opposite}{Hypotenuse}$$
![Triangle](https://i.pinimg.com/originals/0d/79/3a/0d793a88f6c69aa8efd54a1012722c12.gif)
<!-- basicblock-end -->

This would create the same card but in deck Math.

There are many other attributes like extra for specifying extra field etc..

Attributes on a file basis

Some attributes like deck can be specified in file basis by using YAML frontmatter.

---
deck: Math
---
<!-- basicblock-start extra="Mnemonics: soh cah toa" reverse="true" -->
What is formula for sin theta?::
$$\frac{Opposite}{Hypotenuse}$$
![Triangle](https://i.pinimg.com/originals/0d/79/3a/0d793a88f6c69aa8efd54a1012722c12.gif)
<!-- basicblock-end -->

This would create two cards in same deck Math due to deck property specified on a file basis.

Also, it will have an extra field as specified and there will be a reverse card created unlike above two examples due to extra and reverse attributes specified on a block basis.

The new card will look like:

Cards

Different Blocks in Obsidian Anki Sync

basicblock

It is used make forward and reversed cards.

Several examples already shown above.

clozeblock

It is used make cloze cards. It suports Anki's cloze card syntax and highlights.

<!-- clozeblock-start -->
The capital of Japan is {{c1:: Tokyo}}
<!-- clozeblock-end -->

or

<!-- clozeblock-start -->
The capital of Japan is ==Tokyo==
<!-- clozeblock-end -->

Any one of the above code would generate this card in anki:

Cards

replaceblock

This is a special block that creates clozes by replacing the specified text.

<!-- replaceblock-start -->
<!-- replace id="1" text="Opposite" -->
<!-- replace id="2" text="Hypotenuse" -->
$$\sin \theta = \frac{Opposite}{Hypotenuse}$$
<!-- replaceblock-end -->

This would generate the cards:

Cards