Skip to content

Commit

Permalink
Refactor Wording, few details on syntax in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pjkaufman committed Oct 24, 2022
1 parent 817ba54 commit 7e82f93
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions packages/remark-math/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,10 @@ If you turn this off, you can still use two or more dollars for text math.
## Syntax

This plugin applies a micromark extensions to parse the syntax.
That basically follows how code works in markdown, except that dollars (`$`)
are used instead of backticks (`` ` ``), and that two dollars instead of 3 is
enough for blocks.
The syntax basically follows how code works in markdown, except that dollars (`$`)
are used instead of backticks (`` ` ``) and that 2 or more dollars instead of 3
or more backticks is enough for blocks.

See its readme for parse details:

* [`micromark-extension-math`](https://github.com/micromark/micromark-extension-math#syntax)
Expand All @@ -150,6 +151,17 @@ See its readme for parse details:
> That means escapes don’t work inside math but you can use more dollars around
> the math instead: `$$\raisebox{0.25em}{$\frac a b$}$$`
> 👉 **Note**: Like code, the difference between “inline” and “block”,
> is in the line endings:
>
> ```markdown
> $$inline$$
>
> $$
> block
> $$
> ```
## HTML
This plugin integrates with [`remark-rehype`][remark-rehype].
Expand Down

0 comments on commit 7e82f93

Please sign in to comment.