Markdown Math

Introduction

The Markdown Math editor (aka Math Editor) is a derived editor for Standard Notes. It is derived from the Upmath editor by Roman Parpalak, but uses KaTeX for client-side rendering. Because the original Upmath editor and the Markdown Math editor render math using slightly different methods, some TeX libraries and their environments may be available in the Upmath editor but not in the Markdown Math editor. For a full list of functions supported by KaTeX, please see the official KaTeX documentation.

Features

  • LaTeX\LaTeX math rendering via KaTeX\KaTeX
  • Markdown with side-by-side live rendering
  • Option to view the HTML source of the rendered markdown
  • Option to overwrite the note text with the contents of a text file on local storage
  • Option to download the plain note text as a text file to save on local storage
  • Option to download the HTML source of the rendered text as a text file to save on local storage

Style Guide

ResultMarkdown
Bold**text** or __text__
Emphasize*text* or _text_
Strike-through~~text~~
Link[text](http://)
Image![text](http://)
Inline Code`code`
Code Block```language
code
```
Unordered List* item
- item
+ item
Ordered List1. item
Blockquote> quote
H1# Heading
H2## Heading
H3### Heading
H4#### Heading
Section Breaks--- or ***

Tables

Colons can be used to align columns.
Copy this into your editor to see what it creates:

| Tables | Are | Cool |
| ---------------- | :-----------: | --------: |
| col 2 is | centered | \$149 |
| col 3 is | right-aligned | \$4.17 |
| privacy is | neat | \$2.48 |
| rows don't need to |be pretty| what? |
| the last line is | unnecessary | really?
| one more | row | Yay! ๐Ÿ˜†

KaTeX\KaTeX

The Markdown Math editor requires double dollar signs. For example, $$\int_0^\infty f(x)dx$$ or $$\pi$$ should yield โˆซ0โˆžf(x)dx\int_0^\infty f(x)dx and ฯ€\pi.

To use Display Mode in the KaTeX, use double dollar signs on new lines. For example,

Text
$$
\int_0^\infty f(x)dx
$$
More Text

should yield:

Text

โˆซ0โˆžf(x)dx\int_0^\infty f(x)dx

More Text

KaTeX\KaTeX Tables

Please see here and here for tables of all the functions and symbols that KaTeX\KaTeX supports.

License

GNU Affero General Public License v3.0

Development

This editor uses Grunt to compile.

Further Resources

Last updated on