Skip to main content

📘 Blueprints

Blueprints are the things AnkiBridge uses to scan for notes in your vault.

Each blueprint describes how a note may be laid out in your Obsidian documents, and fancy logic behind the scenes ensures that no collisions between two blueprints are possible.

Any individual blueprint can be enabled or disabled using the settings tab.

đŸĨĒ Sandwich​

The sandwich blueprint is enclosed by #anki/start and #anki/end tags. The front and back fields sandwich a #anki/--- tag.

The Sandwich blueprint was the first blueprint added and is generally inferior to the BasicCodeBlock blueprint.

Recommendation

I would recommend changing all Sandwich-style notes to the newer BasicCodeBlock-style

Compatibility​

ModeCompatibilityComment
Live Preview🟡Not great
Reading✔

Example​

#anki/start
```anki-config
id: 1636912129121
deck: Math
tags:
  - equation
```
A function with period $L$ can be written as a __Fourier Series__:
#anki/---
$$
\begin{gather}
    f(x) = \frac{1}{2} a_0 + ∑\limits_{n=1}^∞ a_n \cos(k_n x) + ∑\limits_{n=1}^∞ b_n \sin(k_n x)\\
    \\
    \quad \text{Where } {k_n = \frac{nĪ€x}{L}}
\end{gather}
$$
#anki/end

đŸ’ģ BasicCodeBlock​

The BasicCodeBlock-format consist of an Anki codeblock, hence the name.

Layout​

Layout of a BasicCodeBlock-style note
```anki
CONFIG HERE
---
FRONT HERE
===
BACK HERE
```

Where both the config and the back are optional. Thus this is also valid:

Both the configuration and back field are optional
```anki

This is a front page

$a = b$

[[link to some other note]]
```

And as is this:

Just front and back
```anki
What is the answer to the question of life the universe and everything?
===
$42$
```

Compatibility​

ModeCompatibilityComment
Live Preview✔
Reading✔

Example​

```anki
id: 1636912129121
deck: Math
tags:
  - equation
---
A function with period $L$ can be written as a __Fourier Series__:
===
$$
\begin{gather}
    f(x) = \frac{1}{2} a_0 + ∑\limits_{n=1}^∞ a_n \cos(k_n x) + ∑\limits_{n=1}^∞ b_n \sin(k_n x)\\
    \\
    \quad \text{Where } {k_n = \frac{nĪ€x}{L}}
\end{gather}
$$
```

Appearance in Live Preview​

Live Preview rendering of a BasicCodeBlock note with math