Skip to content

Commit

Permalink
improve readme wording
Browse files Browse the repository at this point in the history
  • Loading branch information
kwshi committed Feb 2, 2021
1 parent f72cd56 commit 24c671f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ This plugin is functionally equivalent to [rehype-katex][rehype-katex] but is
specifically intended to be used with [mdsvex][mdsvex] (markdown format for
[Svelte][svelte]).

The key issue it addresses is that curly braces in LaTeX, e.g. `{x}`, conflict
The key issue it addresses is that LaTeX curly braces (e.g. `{x}`) conflict
with Svelte's template syntax; as such, using rehype-katex to serialize a LaTeX
expression such as `\frac{x}{y}` would result in "`x` is not defined" and "`y`
is not defined" errors. This plugin fixes those errors by rendering KaTeX
content via `{@html "..."}` instead of directly as HTML nodes (which is what
content via `{@html "..."}` instead of plain HTML nodes (which is what
rehype-katex does), preventing curly-brace content from getting treated as
Svelte template expressions.

Expand Down

0 comments on commit 24c671f

Please sign in to comment.