Obsidian Latex Suite

When multiple keymaps are assigned to the same key, the plugin executes them in the following priority order:

1. Auto delete $
2. Expand snippets automatic snippets
3. Expand manual snippets (using triggerKey or the default triggerKey)
4. Select the next tabstop
5. Select the previous tabstop
6. Auto fraction
7. Priority tabout (e.g., only tabout when the cursor is inside brackets)
8. Add \ and a newline in a matrix
9. Add a new cell/ & in a matrix
10. Go to the next line in a matrix
11. Tabout to the next closing bracket or exit the equation
12. Tabout if you type a closing delimiter (e.g. },],))

Note: If a feature is disabled in settings, it is skipped in this order.

To begin typesetting LaTeX, type dm to enter display math mode. The plugin uses snippets to expand shorthand into full LaTeX commands.

Common default examples:

• xsr → x^{2}
• x/y + <kbd>Tab</kbd> → \frac{x}{y}
• sin @t → \sin \theta (where @t is a tabstop)
• par + <kbd>Tab</kbd> + f + <kbd>Tab</kbd> + x + <kbd>Tab</kbd> → \frac{\partial f}{\partial x}

When your cursor is inside a matrix, array, align, or cases environment, you can use these keyboard shortcuts to navigate and edit:

• <kbd>Tab</kbd>: Insert the & symbol (column separator).
• <kbd>Enter</kbd>: Insert \\ and move to a new line.
• <kbd>Shift + Enter</kbd>: Move to the end of the next line (useful for exiting the matrix environment).

Select a portion of math with your cursor and press a single character to wrap it in LaTeX annotation commands:

• U: Surround with \underbrace
• O: Surround with \overbrace
• C: Surround with \cancel
• K: Surround with \cancelto
• B: Surround with \underset

Visual snippets allow you to wrap a current selection with specific text or transform it.

String-based Visual Snippets

Use the v option and include the special string ${VISUAL} in your replacement string. The ${VISUAL} placeholder is replaced by the current selection.

{trigger: "U", replacement: "\\underbrace{ ${VISUAL} }_{ $0 }", options: "mA"}

Function-based Visual Snippets

Use the v option and provide a function that takes the selection (sel) as an argument. The function must return a string or false (to ignore the snippet).

// Wraps selection in \cancelto{...}
{trigger: "K", replacement: (sel) => ("\\cancelto{ $0 }{" + sel + "}"), options: "mv"}

// Converts spaces in selection to hyphens
{trigger: "-", replacement: sel => { if (!sel.includes(" ")) { return false } return sel.replaceAll(/\s+/g, "-")}, options: "vA"}

Tabout improves navigation when working with equations:

• Exit Equation: If the cursor is at the end of an equation, pressing <kbd>Tab</kbd> moves the cursor outside the $ symbols.
• Jump Delimiters: If inside a \left ... \right pair, <kbd>Tab</kbd> jumps to the position after the \right command.
• Jump Brackets: Otherwise, <kbd>Tab</kbd> advances the cursor to the next closing bracket: ), ], }, \rangle, or \rvert.

The Auto-fraction feature allows you to type a fraction using the / symbol. Typing numerator/ will expand to \frac{numerator}{} and place your cursor inside the denominator brackets. Press <kbd>Tab</kbd> to exit the fraction once finished.

Examples:

• x/ → \frac{x}{}
• (a + b(c + d))/ → \frac{a + b(c + d)}{}

The plugin supports a subset of Vim keybindings via codemirror-vim.

Visual Snippets in Vim: Visual snippets can be triggered in Insert mode, but not in Visual mode. To bridge this, you can define a custom Vim shortcut in settings that switches from Visual mode to Insert mode while maintaining the selection.

Setup:

1. Enable Vim mode in both Obsidian and the plugin settings.
2. Define a shortcut in settings using a Vim keybinding with no spaces (e.g., :imap <C-a> <Esc>).

Limitations:

• The shift key (<S-a>) is known not to work for these mappings.
• Macros are not currently supported for visual snippets.

Regex snippets allow for dynamic expansion based on match patterns. To use them, either use the r option or provide a RegExp literal as the trigger.

Capturing Groups

• In the trigger, use () to create capturing groups.
• In the replacement string, use [[X]] to insert the match from capturing group X (starting from 0).

Example

Expanding x2 to x_{2}:

{trigger: "([A-Za-z])(\\d)", replacement: "[[0]]_{[[1]]}", options: "rA"}

Or using a RegExp literal:

{trigger: /([A-Za-z])(\d)/, replacement: "[[0]]_{[[1]]}", options: "A"}

Warning: Special characters like \, +, and . must be escaped with double backslashes (\\) in string-based triggers.

Conceal mode hides LaTeX markup and displays math in a pretty, readable format (e.g., \dot{x}^{2} becomes ẋ²).

Setup Requirements:

1. Enable the feature in the plugin settings.
2. Font Support: Your Obsidian monospace font must support these symbols. It is recommended to use JuliaMono.

If you don't want to install the font system-wide, add this to your Obsidian CSS file:

@font-face {
    font-family: JuliaMono;
    src: url(https://github.com/cormullion/juliamono/raw/refs/heads/master/webfonts/JuliaMono-Regular.woff2) format("woff2");
    text-rendering: optimizeLegibility;
}

body {
  --font-monospace-override: JuliaMono;
}

Usage:

• Move your cursor over a concealed equation to reveal the LaTeX syntax.
• You can configure a delay for the reveal in settings to make arrow-key navigation more intuitive.