Skip to content

Commit 7e82f93

Browse files
authored
Refactor Wording, few details on syntax in readme
Closes GH-79.
1 parent 817ba54 commit 7e82f93

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

packages/remark-math/readme.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,10 @@ If you turn this off, you can still use two or more dollars for text math.
139139
## Syntax
140140

141141
This plugin applies a micromark extensions to parse the syntax.
142-
That basically follows how code works in markdown, except that dollars (`$`)
143-
are used instead of backticks (`` ` ``), and that two dollars instead of 3 is
144-
enough for blocks.
142+
The syntax basically follows how code works in markdown, except that dollars (`$`)
143+
are used instead of backticks (`` ` ``) and that 2 or more dollars instead of 3
144+
or more backticks is enough for blocks.
145+
145146
See its readme for parse details:
146147

147148
* [`micromark-extension-math`](https://github.com/micromark/micromark-extension-math#syntax)
@@ -150,6 +151,17 @@ See its readme for parse details:
150151
> That means escapes don’t work inside math but you can use more dollars around
151152
> the math instead: `$$\raisebox{0.25em}{$\frac a b$}$$`
152153
154+
> 👉 **Note**: Like code, the difference between “inline” and “block”,
155+
> is in the line endings:
156+
>
157+
> ```markdown
158+
> $$inline$$
159+
>
160+
> $$
161+
> block
162+
> $$
163+
> ```
164+
153165
## HTML
154166
155167
This plugin integrates with [`remark-rehype`][remark-rehype].

0 commit comments

Comments
 (0)