obsidian-math-in-callout - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #llm #android #machine-learning #rust #docker #macos #java #security #pytorch #ios #openai #open-source

obsidian-math-in-callout

(★ 51)

An Obsidian plugin to add better Live Preview support for math rendering inside callouts & blockquotes.

File Explorer

Download Latest Version (.zip)

- - release.yml
- blockquote-after.png
- blockquote-before.png
- callout-after.png
- callout-before.png
- decorations.ts
- main.ts
- patch-widget-type.ts
- quote-field.ts
- settings.ts
- utils.ts
.editorconfig
.gitignore
.npmrc
esbuild.config.mjs
eslint.config.mjs
LICENSE
manifest.json
package.json
pnpm-lock.yaml
README.md
styles.css
tsconfig.json
version-bump.mjs
versions.json

# Installation Guide

1. Get the code

git clone https://github.com/RyotaUshio/obsidian-math-in-callout

Downloads the entire project code from GitHub to your computer.

cd obsidian-math-in-callout

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Better Math in Callouts & Blockquotes

This is an [Obsidian.md](https://obsidian.md) plugin to add better Live Preview support for math rendering inside callouts & blockquotes.

> Note: The feature of this plugin was originally a part of [LaTeX-like Theorem & Equation Referencer](https://ryotaushio.github.io/obsidian-latex-theorem-equation-referencer/), another community plugin of mine. I completely rewrote it with a bunch of improvements and decided to release it as a separate plugin for better modularity.

## Features

### Math in Callouts

In Live Preview, the vanilla Obsidian does not render MathJax in callouts while editing them. 
This plugin solves this problem.

Moreover, it also enables proper handling of multi-line math blocks; see [the next section](math-in-lockquotes) below.

#### Example

Without this plugin                 | With this plugin
:-----------------------------------:|:----------------------------------:
![Before](https://raw.githubusercontent.com/RyotaUshio/obsidian-math-in-callout/master/fig/callout-before.png) | ![After](https://raw.githubusercontent.com/RyotaUshio/obsidian-math-in-callout/master/fig/callout-after.png)

### Math in Blockquotes

In Live Preview, the vanilla Obsidian misunderstands a ">" symbol at the beginning of a line in a blockquote or a callout as an inequality sign ("greater than") in multi-line math blocks, while Reading View properly recognizes them. This plugin makes them consistent with Reading View.

#### Example

```
> $$
> \begin{align}
> a &= b \\
>   &= c
> \end{align}
> $$
```

Without this plugin                 | With this plugin
:-----------------------------------:|:----------------------------------:
![Before](https://raw.githubusercontent.com/RyotaUshio/obsidian-math-in-callout/master/fig/blockquote-before.png) | ![After](https://raw.githubusercontent.com/RyotaUshio/obsidian-math-in-callout/master/fig/blockquote-after.png)

## Installation

You can find this plugin in the community plugin browser within Obsidian.

You can also install the latest beta release using [BRAT](https://github.com/TfTHacker/obsidian42-brat).

1. Install the latest version of BRAT and enable it.
2. Open the following URL in browser: `obsidian://brat?plugin=RyotaUshio/obsidian-math-in-callout`.
3. Click the "Add Plugin" button.
4. _(Optional but highly recommended)_ In the BRAT settings, turn on `Auto-update plugins at startup` at the top of the page.

## Companion plugins

Here's a list of other math-related plugins I've developed:

- [LaTeX-like Theorem & Equation Referencer](https://github.com/RyotaUshio/obsidian-latex-theorem-equation-referencer)
- [No More Flickering Inline Math](https://github.com/RyotaUshio/obsidian-inline-math)
- [MathJax Preamble Manager](https://github.com/RyotaUshio/obsidian-mathjax-preamble-manager)
- [Auto-\\displaystyle Inline Math](https://github.com/RyotaUshio/obsidian-auto-displaystyle-inline-math)

## Support development

If you find this plugin useful, please support my work by buying me a coffee!

<a href="https://www.buymeacoffee.com/ryotaushio" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>