{"id":50873735,"url":"https://github.com/loglux/auto-math-for-obsidian","last_synced_at":"2026-06-15T07:33:11.577Z","repository":{"id":319093852,"uuid":"1077557106","full_name":"loglux/auto-math-for-obsidian","owner":"loglux","description":"Auto-expand LaTeX math snippets in Obsidian — write equations faster.","archived":false,"fork":false,"pushed_at":"2025-11-17T01:04:50.000Z","size":35,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-17T03:07:43.567Z","etag":null,"topics":["auto-completion","latex","markdown","math","mathematical-expressions","mathematics","notes","obsidian-plugin","productivity"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loglux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-16T12:16:51.000Z","updated_at":"2025-11-17T01:02:58.000Z","dependencies_parsed_at":"2025-10-18T03:07:27.928Z","dependency_job_id":"32b597d3-bdad-463c-bbc5-785f8f0ff11f","html_url":"https://github.com/loglux/auto-math-for-obsidian","commit_stats":null,"previous_names":["loglux/auto-math-for-obsidian"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/loglux/auto-math-for-obsidian","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loglux%2Fauto-math-for-obsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loglux%2Fauto-math-for-obsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loglux%2Fauto-math-for-obsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loglux%2Fauto-math-for-obsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loglux","download_url":"https://codeload.github.com/loglux/auto-math-for-obsidian/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loglux%2Fauto-math-for-obsidian/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34353193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-completion","latex","markdown","math","mathematical-expressions","mathematics","notes","obsidian-plugin","productivity"],"created_at":"2026-06-15T07:33:11.087Z","updated_at":"2026-06-15T07:33:11.569Z","avatar_url":"https://github.com/loglux.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 📐 Auto Math for Obsidian\n\n✍️ **Write equations at the speed of thought — automatic LaTeX snippet expansion for Obsidian.**\n\nAuto Math automatically expands LaTeX-style math snippets while you type in Obsidian.  \nIt's like a mini _LaTeX auto-completion engine_ — lightweight, fast, and entirely local.\n\n---\n\n### ✨ Features\n\n- 🔹 **Instant snippet expansion** – type `\\frac`, `\\sqrt`, `\\sum`, etc., and get ready-to-edit templates.\n\n- 🔹 **Smart Limits** – optional context‑aware behaviour for ∫ (disabled by default):\n    - `$…$` → compact form (`\\int_{}^{}`)\n    - `$$…$$` → display form with limits (`\\int\\limits_{}^{}`)\n\n- 🔹 **Multiline templates** – environments like `\\align` expand across multiple lines with proper formatting.\n\n- 🔹 **Custom rule file** – all expansions are stored in `.obsidian/plugins/auto-math/rules.json` (user-editable).\n\n- 🔹 **Live reload** – changes in the rules file are applied immediately, no restart required.\n\n- 🔹 **Built-in math pack** – includes 38 essential LaTeX commands.\n\n- 🔹 **Custom Rules Editor** – edit triggers and expansions directly inside Obsidian settings.\n\n- 🔹 **Toggle anytime** – quickly enable or disable with the ribbon icon or command palette.\n\n---\n\n### 🆚 How Auto Math Differs from Other Plugins\n\nThere are several LaTeX-related plugins available for Obsidian. Here's how Auto Math compares:\n\n| Feature | Auto Math | Latex Suite | Quick LaTeX | Completr |\n|---------|-----------|-------------|-------------|----------|\n| **Approach** | Instant trigger expansion | Snippets + shortcuts | Auto-completion menu | General autocomplete |\n| **Triggers** | Standard LaTeX commands | Custom shortcuts | Mixed | Various |\n| **Learning curve** | Minimal | Steeper | Moderate | Moderate |\n| **Configuration** | Simple JSON file | Complex config | Settings UI | Multiple sources |\n| **Focus** | Math snippets only | Full LaTeX workflow | LaTeX shortcuts | All text types |\n| **Popup menus** | None | Optional | Yes | Yes |\n\n#### Why choose Auto Math?\n\n1. **No new shortcuts to learn** — Triggers are standard LaTeX commands (`\\frac`, `\\sqrt`, `\\int`). If you know LaTeX, you already know how to use Auto Math. Perfect for beginners learning LaTeX.\n\n2. **Simplicity** — Does one thing well: expand triggers instantly. No menus, no popups, no complex configuration.\n\n3. **Predictability** — Every trigger expands exactly the same way, every time. No magic, no surprises.\n\n4. **Flexibility** — All rules are stored in a simple JSON file. Edit it directly or use the built-in settings editor.\n\n5. **Lightweight** — Zero dependencies, minimal footprint, works entirely offline.\n\n**Best for:** Users who want fast, predictable LaTeX snippet expansion without learning new shortcuts or dealing with complex configuration.\n\nFor detailed documentation, tutorials, and examples, visit the **[Auto Math Wiki](https://github.com/loglux/auto-math-for-obsidian/wiki)**.\n\n---\n\n### 🧮 Default Rule Pack\n\nAuto Math v0.2.5 comes preloaded with 38 essential triggers:\n\n#### Basic Commands\n\n|Trigger|Expands to|\n|---|---|\n|`\\frac`|`\\frac{}{}`|\n|`\\dfrac`|`\\dfrac{}{}`|\n|`\\tfrac`|`\\tfrac{}{}`|\n|`\\cfrac`|`\\cfrac{}{}`|\n|`\\binom`|`\\binom{}{}`|\n|`\\dbinom`|`\\dbinom{}{}`|\n|`\\tbinom`|`\\tbinom{}{}`|\n|`\\text`|`\\text{}`|\n|`\\sqrt`|`\\sqrt{}`|\n|`\\root`|`\\sqrt[]{}`|\n|`\\pow`|`{}^{}`|\n|`\\abs`|`\\left\\|{}\\right\\|`|\n|`\\norm`|`\\left\\\\|{}\\right\\\\|`|\n|`\\vec`|`\\vec{}`|\n|`\\hat`|`\\hat{}`|\n|`\\bar`|`\\bar{}`|\n|`\\overline`|`\\overline{}`|\n|`\\underline`|`\\underline{}`|\n|`^^`|`^{}`|\n|`__`|`_{}`|\n\n#### Sums, Integrals \u0026 Limits\n\n|Trigger|Expands to|\n|---|---|\n|`\\sum`|`\\sum_{}^{}`|\n|`\\int`|`\\int_{}^{}`|\n|`\\lim_`|`\\lim_{}`|\n|`\\limsup`|`\\limsup_{}`|\n|`\\liminf`|`\\liminf_{}`|\n|`\\max`|`\\max_{}`|\n|`\\min`|`\\min_{}`|\n|`\\inf_`|`\\inf_{}`|\n|`\\sup`|`\\sup_{}`|\n\n#### Logarithms\n\n|Trigger|Expands to|\n|---|---|\n|`\\log`|`\\log_{}`|\n\n#### LaTeX Environments\n\n|Trigger|Expands to|Use case|\n|---|---|---|\n|`\\align`|`\\begin{align}...\\end{align}`|Aligned equations (with numbering)|\n|`\\aligned`|`\\begin{aligned}...\\end{aligned}`|Aligned equations (no numbering)|\n|`\\gather`|`\\begin{gather}...\\end{gather}`|Centred equations|\n|`\\cases`|`\\begin{cases}...\\end{cases}`|Piecewise functions|\n|`\\array`|`\\begin{array}{}...\\end{array}`|Custom arrays|\n|`\\matrix`|`\\begin{matrix}...\\end{matrix}`|Matrix (no brackets)|\n|`\\pmatrix`|`\\begin{pmatrix}...\\end{pmatrix}`|Matrix with ( )|\n|`\\bmatrix`|`\\begin{bmatrix}...\\end{bmatrix}`|Matrix with [ ]|\n|`\\split`|`\\begin{split}...\\end{split}`|Split equations|\n\n---\n\n### ⚙️ Installation\n\n#### Manual\n\n1. Download the latest release from the [Releases](https://github.com/loglux/auto-math-for-obsidian/releases/) page.\n\n2. Extract the folder `auto-math` into your vault under:\n\n    ```\n    .obsidian/plugins/auto-math/\n    ```\n\n3. Enable **Auto Math** in _Settings → Community Plugins → Installed plugins_.\n\n4. That's it — start typing `\\frac`, `\\sqrt`, `\\sum` and watch them expand automatically!\n\n\n---\n\n### 🧰 Configuration\n\nOpen **Settings → Auto Math** to customise:\n\n- **Enabled** – toggle Auto Math on/off.\n\n- **Rules file path** – defaults to `.obsidian/plugins/auto-math/rules.json`.\n\n- **Smart Limits** – context‑aware expansions for ∫ (disabled by default, enable in settings if needed).\n\n- **Reload / Create / Open** – reload or open your external rules file.\n\n- **Debug logs** – show extra information in the developer console.\n\n- **Custom Rules Editor** – view, add, delete, filter, sort, and edit your rules interactively.\n\n- **Save rules to file** – writes changes to the JSON file immediately.\n\n- **Reset to default math pack** – restores the built-in default rule set.\n\n---\n\n### 📐 Multiline Maths Mode\n\nAuto Math now supports Smart Limits in multiline `$$...$$` blocks.\n\n**Example:**\n```markdown\n$$\n\\int x dx  ← expands to \\int\\limits_{}^{}\n$$\n```\n\nThe plugin automatically scans neighbouring lines (up to 50 by default) to detect display maths context.\n\n**Technical note:** The scan depth can be adjusted by modifying `maxScanLines` in the plugin settings file (default: 50 lines). This is stored in `.obsidian/plugins/auto-math/data.json`.\n\n---\n\n## LaTeX Environments\n\nAuto Math includes snippets for common LaTeX environments. These automatically expand into multiline blocks with proper formatting.\n\n### Example Usage\n\n**Input:**\n```markdown\n$$\n\\align\n$$\n```\n\n**Expands to:**\n```markdown\n$$\n\\begin{align}\n| ← cursor here\n\\end{align}\n$$\n```\n\nThen you can write your equations with `\\\\` for line breaks:\n```markdown\n$$\n\\begin{align}\nx + y \u0026= 5 \\\\\nx \u0026= 5 - y\n\\end{align}\n$$\n```\n\n**Result:**\n$$\n\\begin{align}\nx + y \u0026= 5 \\\\\nx \u0026= 5 - y\n\\end{align}\n$$\n\n---\n\n### 💡 Customisation Example\n\nIf you'd like to add your own expansions, open `auto-math.rules.json` and add entries like:\n\n```json\n[\n  { \"trigger\": \"\\\\ceil\", \"expand\": \"\\\\left\\\\lceil{}\\\\right\\\\rceil\" },\n  { \"trigger\": \"\\\\floor\", \"expand\": \"\\\\left\\\\lfloor{}\\\\right\\\\rfloor\" },\n  { \"trigger\": \"\\\\bmatrix\", \"expand\": \"\\\\begin{bmatrix}\\n \u0026 \\\\\\\\\\n\\\\end{bmatrix}\" }\n]\n```\n\nThen click **Reload rules now** — your new triggers will be active instantly.\n\n---\n\n### 🪶 Notes\n\n- The plugin works fully offline and doesn't require any external dependencies.\n\n- Uses plain JSON and Obsidian's own vault API.\n\n- Safe to edit while running — changes are detected automatically.\n\n---\n\n## Documentation\n\nFor more details, tips, and extended explanations, check the project Wiki:\nhttps://github.com/loglux/auto-math-for-obsidian/wiki\n\n---\n\n### 🧑‍💻 Credits\nReleased under the MIT licence.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floglux%2Fauto-math-for-obsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floglux%2Fauto-math-for-obsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floglux%2Fauto-math-for-obsidian/lists"}