/obsidian-math-booster

Turn your Obsidian into LaTeX on steroids.

Primary LanguageTypeScriptMIT LicenseMIT

Math Booster for Obsidian

Turn your Obsidian into LaTeX on steroids with Math Booster.

Screenshot

Math Booster is an Obsidian.md plugin that enhances your mathematical note-taking experience with several powerful features, including:

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 the styles gallery for examples.

Also check out the No More Flickering Inline Math plugin that lets you work with inline math much more comfortably.

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

Support development

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

Buy Me A Coffee

Documentation

https://ryotaushio.github.io/obsidian-math-booster/

Dependencies

The following community plugins are required to be installed and enabled.

Also, you must install the CMU Serif font to fully enjoy some of the preset styles listed below. Additionally, the Noto Sans JP font is required to render proofs using the Japanese profile correctly.

Installation

You can install this plugin inside Obsidian (see here for instructions).

Also, you can test the latest beta release using the BRAT plugin.

Contributing

I need your help!!

  • 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 Math Booster and our experience!
    • Even if you don't code, your help is still needed to improve the documentation and README. For example, the active update of this plugin has already made some of the images in the documentation outdated...
    • Of course, programmers' contribution is highly welcomed. (I'm pretty new to TypeScript/JavaScript/HTML/CSS. Making this plugin was the only purpose for me to start learning them. So your help is needed for real.)

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.
  • More user-friendly UI for local settings

Styles gallery

Plain

Plain light Plain dark

View CSS snippet

Framed

Framed Framed dark

View CSS snippet

MathWiki style

This beautiful style is taken from MathWiki. A big thank you to Zhaoshen Zhai, the owner of MathWiki and the MathLinks plugin, for readily consenting to including it in this documentation.

MathWiki style

View CSS snippet

Vivid

Vivid light Vivid dark

View CSS snippet