Skip to content

Commit

Permalink
1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyuping committed Oct 4, 2021
1 parent c24cc9c commit f093d2d
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This simple plugin adds various shortcuts to speedup latex math typing.
### 1. Move cursor between \$\$ symbols
* Typing two consecutive **\$** will automatically shift the cursor in between the **\$\$** symbols.

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/move%20cursor%20within%20math.gif" width="500" />
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoMoveintoMath.gif" width="500" />

### 2. Autoclose {}, [], () brackets
* Typing **"{"**, **"["** and **"("** will automatically close with **"}"**,**"]"** or **")"**.
Expand All @@ -21,27 +21,35 @@ This simple plugin adds various shortcuts to speedup latex math typing.
### 4. Auto enlarge brackets that contains \sum, \int or \frac
* Place cursor right after a () or [] bracketed expression that contains either \sum, \int or \frac and press the space key, the outermost brackets will be appended with \left and \right in order to display larger brackets to enclose these big expressions. E.g. (\sum\limits_{i=1}^n x+1) => **\left**(\sum\limits_{i=1}^n x+1 **\right**)

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/enlarge%20bracket.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoEnlargeBracket.gif" width="500"/>

### 5. Auto enclose expression after superscipt with {}
* Typing expressions after superscript **"^"** symbol follow by a **"space" key** will automatically surround the expressions with **"{}"**.

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/superscript.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoEncloseSup.gif" width="500"/>

### 6. Auto Fraction - Type "/" instead of \frac{}{}.
* Type **\$e/2\$** followed by a **"space" key** will automatically replace the expression with **\$\frac{e}{2}\$**.

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoFraction.gif" width="500"/>

* **Tip 1:** Enclose your fraction expression within round brackets () will help the system identify the boundaries of your fraction.

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoFraction1%20-%20enclose%20with%20round%20bracket.gif" width="500"/>

* **Tip 2:** Put a **space** infront of fraction to denote the start of the fraction. Especially useful for series of fractions!

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoFraction2%20-%20space.gif" width="500"/>

* **Tip 3:** For longer numerator or denominator expressions (especially when the expressions have white spaces which may trigger the frac-replace prematurely), enclose the expressions in round brackets **()**.

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_autoFraction3%20-%20numeratordenominator.gif" width="500"/>


* **Tip 4:** The plugin will remove the outermost brackets in numerator and denominator.

<img src="imagehttps://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac1.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac2.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac3.gif" width="500"/>



### 7. Shortcut for Align Block
* use "Alt+Shift+A" (Mac: "Option+Shift+A") shortcut key to quickly insert **\begin{align\*} \end{align\*}** block
Expand All @@ -58,7 +66,7 @@ This simple plugin adds various shortcuts to speedup latex math typing.
* **Tip 4: Edit Short Cut**
* You may edit the shortcut keys in **Settings -> Hotkeys**

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/align%20block.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_alignblock.gif" width="500"/>

### 8. Shortcut for Matrix Block
* use "Alt+Shift+M" (Mac: "Option+Shift+M") shortcut key to quickly insert **\begin{pmatrix} \end{pmatrix}** block
Expand All @@ -74,7 +82,7 @@ This simple plugin adds various shortcuts to speedup latex math typing.
* **Tip 3: Edit Short Cut**
* You may edit the shortcut keys in **Settings -> Hotkeys**

<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/matrix%20block.gif" width="500"/>
<img src="https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/g_matrixblock.gif" width="500"/>

---
## Note:
Expand Down

0 comments on commit f093d2d

Please sign in to comment.