Features

Functional Features

Features that I'd expect to work without further ado since Obsidian supports it by default. There exist some explorative test cases in the repo's test/vaul.

Media

# Black Hole #card

![[blackhole_1600.jpg]]

MathJax / "LaTeX"

# Basis Change #card
$\exists T:(t_{ij}\in M_n(K)),$ let there be: $$v_j'=\sum^n_{i=1}t_{ij}v_i$$

Code Syntax Highlighting

GFM Alerts

Note

Take a look at the marked plugin docs for supported alert types

# This is a alert #card
> ![TIP]
> I'm a tip!

Processing Settings

Generally, there are four scopes for settings:

1. Global plugin settings
2. Note frontmatter settings
3. Heading context
4. Inline cards

Frontmatter-scoped settings can be added to the note's frontmatter section to take effect for all cards generated from the note, if not overwritten locally.

The heading-scoped settings can be added right below a heading, are parsed in the same yaml syntax as the Obsidian frontmatters and must be inside a Obsidian comment block (%% <- here -> %%).

A valid heading context in an Obsidian comment block might e.g. be:

# Heading #card
%%
deck: My::Custom::Deck
%%

It is also possible to write the keys inline with the yaml object syntax so that those blocks don't take up too much space:

# Heading #card
%% { deck: My::Custom::Deck, context: false } %%

The inline-scoped settings follow the same syntax as the heading context ones.

Include Heading Context

Include the ancestor headings as prefix to the Question in the note's front

Scopes: Plugin settings & note frontmatter

The outcome of generating a flashcard from the following note and this setting enabled in the setting (which is the default):

# Context 1

## Context 2

### Question #card
Answer

Context 1 > Context 2 > Question
---
Answer

If you perhaps don't like this for a certain note type (e.g. vocabulary), you can add the frontmatter override (or of course disable it globally):

---
cards-context: false
---

# Context 1

## Context 2

### Question #card
Answer

Question
---
Answer

Default & Path-based Decks

The deck in which a flashcard is added or moved is (by default) determined by the vault path it is located in. The / or \ in the folder paths are just substituted with ::.

However, if a not is located in the root of your vault, it get added to the "Default Deck" specified in the plugin settings (which defaults to "Default" lol).

Path-based Deck

If turned off, the placement of the note is determined by the (default) deck (see next section).

Scopes: Global settings & note frontmatter

E.g. this note in the vault path /wiki/features/Path Based Deck

---
cards-path-based: false
---

# Question #card
Answer

Would be placed in the Anki deck Default.

(Default) Deck

The Anki deck in which the cards of a Obsidian note are placed into.

Scopes: (Global settings, ) note frontmatter & heading context

Takes precedence over the cards-paths-based on frontmatter level:

---
cards-path-based: false
cards-deck: wiki::features::deck
---

# Question #card
Answer

This card would be inserted in the wiki::features::deck Anki deck path. Take note that the casing doesn't have to match the on in Anki.

Tip

This setting in context scope allows for relative deck manipulation, just like paths in the filesystem of a UNIX computer:

• << = one deck up (just like ..)
• :: = the deck separator (just like / or \), except when it is the first two symbols - then it's semantic is ./

---
cards-deck: wiki::features::deck
---

# Question #card
Answer

# Question related to Features #card
%% { deck: << } %%
Answer

The second card is inserted in the wiki::features Anki deck, the first one as to be expected in the wiki::features::deck deck

---
cards-deck: wiki::features::deck
---

# Question #card
%% { deck: ::test } %%
Answer

This card would be included in the wiki::features::deck::test Anki deck.

This also works on path based deck names, it will warn you about this though since paths can change accidentally:

---
cards-path-based: true # or in the global plugin settings
---

# Question #card
%% { deck: ::test } %%
Answer

Full absolute paths - just like in the cards-deck frontmatter key - are also possible:

# Question #card
%% { deck: wiki::test } %%
Answer

Tag Inclusion

Frontmatter Tags

Include the tags from the frontmatter section into each card of the note

Scopes: Global settings & note frontmatter

Heading Context Tags

Combine the tags of ancestor heading with the other tags of the current card

Scopes: Global settings, note frontmatter & heading context

Might be convenient in cases like this:

---
cards-context: "tags" # excludes "headings"
tags:
  - japanese
  - vocab
---

# Unit 6

## Nouns #nouns
- textbook :: {教科書|きょうかしょ}

### Everyday Live
- convenience store :: コンビに

textbook #japanese #vocab #nouns
---
<ruby>教科書<rt></rt>きょうかしょ</ruby>