Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryotaushio/obsidian-math-in-callout
An Obsidian plugin to add better Live Preview support for math rendering inside callouts & blockquotes.
https://github.com/ryotaushio/obsidian-math-in-callout
latex math obsidian
Last synced: 4 months ago
JSON representation
An Obsidian plugin to add better Live Preview support for math rendering inside callouts & blockquotes.
- Host: GitHub
- URL: https://github.com/ryotaushio/obsidian-math-in-callout
- Owner: RyotaUshio
- License: mit
- Created: 2023-11-27T15:07:17.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-12T07:06:23.000Z (about 1 year ago)
- Last Synced: 2024-01-12T18:50:04.752Z (about 1 year ago)
- Topics: latex, math, obsidian
- Language: TypeScript
- Homepage:
- Size: 318 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
:-----------------------------------:|:----------------------------------:
 | 
### 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
:-----------------------------------:|:----------------------------------:
 | 
## 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!
