Skip to content

Commit

Permalink
document latex notation to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yagarea committed Mar 21, 2022
1 parent f50e6cd commit 7cd163d
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Enjoy comfort of latex and markdown without cluttering your site with bloated ja

## Usage

### Notation
### Kramdown notation
**Inline formula**
Put formula between two pairs of dolar signs (`$$`) inside of paragraph.
```latex
Expand All @@ -45,6 +45,27 @@ display mode?
This is how [kramdown](https://kramdown.gettalong.org/)(Jekyll's markdown parser) works
so I decided to respect this convention. It makes this plugin more consistent and universal._


### LaTex math mode notation
**Inline formula**
Put formula between two escaped brackets `\(` `\)`.
```latex
Lorem ipsum dolor sit amet, consectetur \(e^{i\theta}=\cos(\theta)+i\sin(\theta)\)
adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
```

**Display formula**
Put formula between two escaped square brackets `\[` `\]`.
```latex
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
\[ \left[ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right] \Psi(\mathbf{r},t) \]
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
ea commodo consequat.
```

### Config
Jektex si highly configurable from your `_config.yml` file

Expand Down

0 comments on commit 7cd163d

Please sign in to comment.