5 mins Quick Start : see Full Tutorial & Guidelines
Complete Features & Updates : see Changelog
Video Tutorial: I'll make a video tutorial if this plugin has 5000 downloads or this repo gets 50 stars.
You can download following 3 files in the latest release page :
main.js
manifest.json
style.cssand put them in .obsidian/plugins/equation-citator folder under your obsidian vault.
Also after this plugin is published in obsidian, you can download it from community plugins.
Obsidian-Equation-Citator is a plugin that provides a simple and elegant way to write in-line equation citation cite equations in obsidian just like \ref{} label in latex.
Here is a simple examples to show how it works.
$$ E = mc^2 \tag{A} $$
This is an equation $\ref{eq:A}$.
this will be rendered as follows (support both light and dark theme) :
-
Why this plugin?
- While the existing plugin Math Booster (or
LaTeX-like Theorem & Equation Referencernow) also provides equation citation in obsidian (since it's based on latex, it can't do cross-file citation and outline-based equation autonumber). Equation citator is focused on providing an easy-to-use, light-weight but more powerful, elegant, and full customizable citation experience.
- While the existing plugin Math Booster (or
-
This plugin would be very helpful if you :
- have habit of adding
\tag{}in equation blocks, and want to have a elegant and powerful way to cite them. - don't want to add ugly block reference
^in your equation blocks for reference, and make your citation more organized and clean.
- have habit of adding
Warning
You should follow some very simple rules to make this plugin work properly, please check Full Tutorial & Guidelines for details.
If an issue occurs because of you are not following such rules, such issue may be closed without being fixed.
Use simple inline $\ref{eq:A}$ format to cite equation block with \tag{A} and preview it just as links in obsidian.
Ctrl + hover to preview the equation of following tag (just hover when in reading mode). double click to jump to location of equation, or ctrl + double click to open on the right and jump
Select tag (\tag{1.2}) and right click to rename tag, and its citation will be automatically updated.
-
Cross-file citation is supported by footnote format. Citing several equations by delimiter
,is also supported. -
Use consecutive format (
~) to cite multiple equations.
# for example
$\ref{eq:1^1.3.1~3, 1^2.1.1~2}$
# but we recommend this nested format after version 1.2.2 :
$\ref{eq:1^{1.3.1~3}, 1^{2.1.1~2}}$ 
Suggest you available equations when adding citations and fill in the equation number in 1-click :
Auto number all the equations in by one click on the sidebar icon :
Original PDF export in obsidian can fail to render citation, so a command Make markdown copy to export PDF is provided to make markdown for export to pdf correctly.
Since it's a new plugin, some bugs or issues may still exist. If you encounter any, please provide the following information on the issue page (if this is a feature coming soon, please not comment on the issue page, but wait for the release update) :
- A description of the bug or issue, along with steps to reproduce it.
- The relevant markdown text that triggers the issue.
- Enable debug mode in the settings tab, and provide the console log (Ctrl + Shift + I in Obsidian).
Tip
Since this plugin have cache mechanism for better performance, some problems like delay or no in-time update (like a little delay for citation update) may happens. So you may wait several seconds, or re-open file or restart obsidian to ensure your issue is not just a normal cache-related behavior.
If u have knowledge about plugin development, you can also find which function is causing the bug or issue, provide testing cases or make pull requests to fix the bug or issue.
Also, if u have any suggestion or question for this plugin, feel free to leave it in the issue page.
Note
Contributors and maintainers are always welcome!
I developed this plugin to help my daily work and follow my personal interests. It's totally free, I would be very glad if anyone can fork this repo and help me to maintain this plugin (since I'm busy during school time).
You can contribute to this plugin by simply forking this repo, submitting a PR and describe what you have done (Please test your code carefully before submitting!).
Very appreciate for your contributions!