Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 6.8 KB

README.md

File metadata and controls

98 lines (65 loc) · 6.8 KB
Raw

LaTeX-like Theorem & Equation Referencer for Obsidian

Important

This plugin had been called Math Booster until version 2.1.4, but has been renamed for better clarity and discoverability. A big thank you to those who shared their thoughts here.

LaTeX-like Theorem & Equation Referencer is an Obsidian.md plugin that provides a powerful indexing & referencing system for theorems & equations in your vault, bringing $\LaTeX$-like workflow into Obsidian.

Screenshot

(The theorem in the screenshot is cited from Tao, Terence, ed. An introduction to measure theory. Vol. 126. American Mathematical Soc., 2011.)

Docs

https://ryotaushio.github.io/obsidian-latex-theorem-equation-referencer/

Features

Note

For more modular and focused enhancements, some features are planned to be transitioned from this plugin to dedicated, specialized plugins in the near future. Below are the upcoming changes:

Transitioning to Better Math in Callouts & Blockquotes

  • Rendering equations inside callouts
  • Multi-line equation support inside blockquotes

Transitioning to Rendered Block Link Suggestions

Theorems & equations can be dynamically/automatically numbered, while you can statically/manually number them if you want. The number prefix can be either explicitly specified or automatically inferred from the note title.

Thanks to the integration with MathLinks, links to theorems/equations are displayed with their title or number, similarly to the cleveref package in LaTeX. (No need for manually typing aliases!)

You can also customize the appearance of theorem callouts using CSS snippets; see here.

Companion plugins

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

Installation

You can install this plugin via Obsidian's community plugin browser (see here for instructions).

Also, you can test the latest beta release using BRAT:

  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 RyotaUshio/obsidian-latex-theorem-equation-referencer in the pop-up prompt and click on Add Plugin.
  4. (Optional) Turn on Auto-update plugins at startup at the top of the page.
  5. Go to Community plugins > Installed plugins. You will find "LaTeX-like Theorem & Equation Referencer" in the list. Click on the toggle button to enable it. Since version 2 is still beta, it's not on the community plugin browser yet.

Dependencies

Obsidian plugins

This plugin requires MathLinks version 0.5.3 or higher installed to work properly (Clever referencing).

In version 2, Dataview is no longer required. But I strongly recommend installing it because it enhances this plugin's search functionality significantly.

Fonts

You have to install CMU Serif to get some of the preset styles for theorem callouts displayed properly.

Additionally, Noto Sans JP is required for render the preset styles properly in Japanese.

Contributing

  • Feel free to create a new issue if something is not working well. Questions are also welcomed.
  • Please send a pull request if you have any ideas to improve this plugin and our experience!
  • Contribution to the docs is also highly appreciated: see here.

Roadmaps

  • Import from LaTeX: ArXiv papers, research/literature notes written in LaTeX, ...
  • Export to LaTeX: Write research notes in Obsidian, and then export them into LaTeX.

Support development

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

Buy Me A Coffee