-
Notifications
You must be signed in to change notification settings - Fork 129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor math formulae support #1940
Conversation
Lgtm otherwise 👍, though if possible @jonahtanjz could take a look as well in case I'm missing anything from the first PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor documentation nits. Implementation wise looks good 👍
Co-authored-by: Jonah Tan <47470981+jonahtanjz@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
What is the purpose of this pull request?
Overview of changes:
Related to #1754
With the latest update in
markdown-it-texmath
, it is now possible to specify a list of delimiters. Hence, this PR aims to refactor the code to take advantage of the new feature.dollars
andbrackets
out of the box for math formulae displaytexWithDollars
plugin intomathDelimiters
, for additional support of other delimiters (optional and only for people who actually need it)Anything you'd like to highlight / discuss:
nil
Testing instructions:
See documentation and functional tests
Proposed commit message: (wrap lines at 72 characters)
Refactor math formulae support
The
dollars
delimiter for math formulae is currently supported viaa plugin because the markdown-it-texmath package does not
allow for more than one delimiter.
With the latest version update, the markdown-it-texmath package
can now support multiple delimiters.
Let's update the code to specify
dollars
as a supported delimiterout of the box for math formulae. Let's also repurpose the
texWithDollars
plugin tomathDelimiters
for any additionaldelimiter addition if any user is interested.
Users can now use
dollars
andbrackets
(two popular) delimitersfor math formulae without any configurations.
Checklist: ☑️