Skip to content

Commit

Permalink
1.2.0 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyuping authored Sep 24, 2021
1 parent e4b8e21 commit f0064cb
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This simple plugin added various shortcut to simplify and speedup latex math typ

**1. Move cursor in between \$\$**
* Typing two consecutive **\$\$** will automatically shift the cursor in between the **\$\$**.
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/move%20cursor%20within%20math.gif)

**2. Autoclose {}, [], () brackets**
* Typing **"{"**, **"["** and **"("** will automatically close with **"}"**,**"]"** or **")"**.
Expand All @@ -16,31 +17,37 @@ This simple plugin added various shortcut to simplify and speedup latex math typ

**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**) : $(\sum\limits_{i=1}^n x+1)$ => $\left(\sum\limits_{i=1}^n x+1\right)$
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/enlarge%20bracket.gif)

**5. Auto enclose expression after superscipt with {}**
* Typing expressions after superscript **"^"** symbol follow by a **"space" key** will automatically surround the expressions with **"{}"**.
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/superscript.gif)

**6. Type "/" instead of \frac{}{}.**
* Type **\$e/2\$** followed by a **"space" key** will automatically replace the expression with **\$\frac{e}{2}\$** and display $\frac{e}{2}$
**Tip 1:** enclose your fraction expression within round brackets () will help the system identify the boundaries of your fraction.
**Tip 2:** for longer numerator or denominator expressions (especially when the expressions have white spaces which may trigger the frac-replace prematurely), enclose the expression in round brackets **()**.
**Tip 3:** The plugin will remove the outermost brackets in numerator and denominator.
E.g. Typing 1/**(** \lambda n **)** followed by space key gives $\frac{1}{\lambda n}$ instead of $\frac{1}{(\lambda n)}$
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac1.gif)
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac2.gif)
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/frac3.gif)

**7. shortcut for align block**
* use "Alt+a" shortcut key to quickly insert **\begin{align\*} \end{align\*}** block
**Tip 1:** if you have already typed some expressions and want to add the \begin{align\*} and \end{align\*} to the front and back, you can first select the texts then press **"Alt+a"**.
**Tip 2: quick next line syntax within align block**
* pressing **"enter"** within a \begin{align} \end{align} block will automatically insert **\\\\** to the end of the line, go to next line and add the **"&"** symbol.
* press **"shift+enter"** to go to next line **without** adding these symbols.
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/align%20block.gif)

**8. shortcut for matrix block**
* use "Alt+m" shortcut key to quickly insert **\begin{pmatrix} \end{pmatrix}** block
**Tip 1: quick next item and next line syntax within pmatrix block**
* pressing **"tab"** within a \begin{pmatrix} \end{pmatrix} block will automatically insert **" & "**.
* pressing **"enter"** within a \begin{pmatrix} \end{pmatrix} block will automatically insert **" \\\\ "**.
* press **"shift+enter"** to go to next line **without** adding these symbols.
![image](https://github.com/joeyuping/quick_latex_obsidian/blob/master/demo%20gif/matrix%20block.gif)

---
**Note:**
Expand All @@ -53,4 +60,4 @@ E.g. Typing 1/**(** \lambda n **)** followed by space key gives $\frac{1}{\lamb
- [ ] add a settings page to allow toggling the various functions

### source code
see https://github.com/joeyuping/quick_latex_obsidian
see https://github.com/joeyuping/quick_latex_obsidian

0 comments on commit f0064cb

Please sign in to comment.