Introduction

LaTeX-like Theorem & Equation Referencer (Math Booster since version 2.1.4) is an Obsidian plugin that provides a powerful indexing & referencing system for theorems & equations in your vault, bringing LaTeX-like workflow into Obsidian.

Pre-Conditions

1. Obsidian
2. Some other plugins:
   1. MathLinks Version $\ge$ 0.5.3
   2. Dataview Version $\ge$ 0.5.56

Installation

Install Pre-Conditioned Plugins

1. To install Community Plugins, you need to disable Safe Mode under Settings -> Community Plugins -> Safe Mode.
2. Click Settings button in the left corner, choose Community Plugins, enter in Community Plugin Market.
3. Search for MathLinks and Dataview plugins and install them.

Install Math Booster

Now let’s stall Math Booster! You can install this plugin via BRAT (Beta Reviewers Auto-update Tester):

1. Install BRAT and enable it.
2. Go to Options. In the Beta Plugin List section, click on the Add Beta plugin button.
3. Copy and paste https://github.com/RyotaUshio/obsidian-math-booster in the pop-up prompt, choose version 2.1.4 (tested successfully) and click on Add Plugin. (vpn REQUIRED!!!)
4. Go to Community plugins > Installed plugins. You will find “Math Booster” in the list. Click on the toggle button to enable it.

Docs

Theorem Callouts

The plugin offers theorem callouts. They are designed for creating theorem environments (theorem, definition, lemma, …) in Obsidian as LaTeX-like as possible.

1
2
3
4
5

> [!theorem] Title
> Content
<!-- or aliases version -->
> [!thm] Title
> Content

It will be rendered as below.

Here’s the complete list of available envionments and aliases:

Unnumbered Theorem Callouts

Similarly to the LaTeX syntax (e.g. \begin{theorem*}), the following will create an unnumbered theorem callout.

1
2

> [!lemma|*] Title
> Content

It will be rendered as below.

Manually Numbered Theorem Callouts

It is also possible to explicitly specify the theorem number by yourself.

1
2

> [!def|A.1] Title
> Content

It will be rendered as below.

Equations

By default, the plugin only numbers equations with backlinks (i.e. the ones that are referenced elsewhere). Alternatively, you can number all equations by turning off the option Equations - numbering > Number only referenced equations.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

$$
f(x)
$$

$$
g(x) \tag{$\ast$}
$$

$$
h(x)
$$
^934f5c

Link to $h(x)$: [[#^934f5c]]

It will be rendered as below.

Custom Link Autocomplete

In the editor, type \ref (by default). Then, live suggestions for all theorem callouts & equation blocks in the entire vault show up.

• Enter: insert a link to the selected item.
• Shift+Enter: insert a link to the note containing the selected item.
• Cmd+Enter on Mac/Ctrl+Enter on Windows: jump to the selected item by pressing.

Use \tref or \eqref (by default) instead of \ref to suggest only theorems or only equations.

Use \ref:r or \tref:r or \eqref:r (by default) to search only within recently opened notes.

Use \ref:a or \tref:a or \eqref:a (by default) to search only within active note.

It will be rendered as below.

Caution: Requiring the Include theorem callout label for search target option to be turned on!

Proof environment

The plugin supports LaTeX-like proof environments.

1
2
3

`\begin{proof}`
Lorem ipsum dolor sit amet, consectetur adipiscing elit, ...
`\end{proof}`

It will be rendered as below.

Use the following syntax to print custom text.
Any inline markdown syntax can be used, but inline formulas will render with flickering in the live preview.

1
2
3

`\begin{proof}[Solution.]`
Lorem ipsum dolor sit amet, consectetur adipiscing elit, ...
`\end{proof}`

It will be rendered as below.

Suppose that you have a theorem like below and it has a block ID 123456.

1
2

> [!thm] Title
> Content

The following will be printed as “Proof of Theorem 1 (Title).” by default.

1
2
3

`\begin{proof}`@[[#^123456]]
Lorem ipsum dolor sit amet, consectetur adipiscing elit, ...
`\end{proof}`

It will be rendered as below.

Reference

1. [official documents]