Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Commit

Permalink
Add link to supported LaTeX macros further fix #46
Browse files Browse the repository at this point in the history
Also appropriate direct links to `docs/math.md` and `docs/options.md`
have been added to README for better exposure.
  • Loading branch information
Galadirith committed Aug 5, 2015
1 parent d5292ae commit 88100d6
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ Long instructions can be found [here][installation]. In short steps:

## Usage

Please see [options][options] for further details on configuring MPP and
[math][math] for more details on math rendering. For basic usage:

- Toggle Preview: `ctrl-shift-m`
- Toggle Math Rendering: `ctrl-shift-x`

Expand All @@ -52,3 +55,4 @@ Markdown Preview Plus (MPP) is released under the [MIT license][license].
[features]: docs/features.md
[node-gyp]: https://github.com/TooTallNate/node-gyp#installation
[mathjax-wrapper]: https://atom.io/packages/mathjax-wrapper
[options]: docs/options.md
9 changes: 6 additions & 3 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ You may configure them in the [settings of MPP][options]
MPP extends the syntax of [GitHub flavored markdown][gfm]
with equation blocks. An equation block is indicated by enclosing it in
double dollar signs `$$...$$`. You can use any LaTeX macros that are valid
in a maths environment of a LaTeX document inside an equation block.
Rendering of LaTeX equations in the preview pane can be toggled with
`ctrl-shift-x`. Please see [math.md](./math.md) for more details.
in a maths environment of a LaTeX document inside an equation block. For a
full list of supported macros please see
[Supported LaTeX commands][macro-support]. Rendering of LaTeX equations in
the preview pane can be toggled with `ctrl-shift-x`. Please see
[math](./math.md) for more details.

- **Pandoc support**

Expand All @@ -32,3 +34,4 @@ You may configure them in the [settings of MPP][options]
[pandoc-args]: http://pandoc.org/README.html#options
[pandoc-flavor]: http://pandoc.org/README.html#pandocs-markdown
[pandoc-cit]: http://pandoc.org/README.html#citations
[macro-support]: http://docs.mathjax.org/en/latest/tex.html#supported-latex-commands
19 changes: 13 additions & 6 deletions docs/math.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# LaTeX style math

This fork of [markdown-preview](https://github.com/atom/markdown-preview)
enables LaTex to be rendered in a preview window of a markdown document in
[Atom](https://atom.io/). If focus is given to either the markdown source editor
or the preview window then this can be toggled in the menu **Packages ›
Markdown Preview Plus › Toggle LaTex Rendering** or using the keymap
`ctrl-shift-x`.
MPP extends the syntax of [GitHub flavored markdown][gfm] with equation blocks.
Inside an equation block you can use any LaTeX macros that are valid in a maths
environment of a LaTeX document. MPP will then render the equation in the
preview window. For a full list of supported macros please see
[Supported LaTeX commands][macro-support].

If focus is given to either the markdown source
editor or the preview window then math rendering can be toggled in the menu
**Packages › Markdown Preview Plus › Toggle LaTex Rendering** or
using the keymap `ctrl-shift-x`.

To enable LaTeX rendering by default search for **Markdown Preview Plus** in the
**Filter packages** input dialogue of the **File › Settings** menu and
Expand Down Expand Up @@ -50,3 +54,6 @@ literally display a dollar sign you can use `\$`.
it's exactly three seconds before i honk your $\int -xe^{x^2} dx$ nose and
pull your underwear over your head ...
````

[gfm]: https://help.github.com/articles/github-flavored-markdown/
[macro-support]: http://docs.mathjax.org/en/latest/tex.html#supported-latex-commands

0 comments on commit 88100d6

Please sign in to comment.