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

feat(markdown): preserve math #5050

Merged
merged 3 commits into from Sep 5, 2018

Conversation

Projects
None yet
2 participants
@ikatyang
Member

ikatyang commented Sep 4, 2018

Fixes #3700

  • preserve inlineMath ($inline$) and blockMath:

    $$
    block
    $$
  • side effect: $ always needs to be escaped.


Prettier pr-5050
Playground link

--parser markdown
--print-width 61
--prose-wrap always

Input:

The equation for the  volume of a rectangular prism is $V = \ell * w * h$.

$\alpha$

Output:

The equation for the volume of a rectangular prism is
$V = \ell * w * h$.

$\alpha$

  • I’ve added tests to confirm my change works.
  • (If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory)
  • I’ve read the contributing guidelines.
@j-f1

Thanks for doing this!

@@ -99,7 +100,7 @@ function genericPrint(path, options, print) {
return printChildren(path, options, print);
case "word":
return node.value
.replace(/[*]/g, "\\*") // escape all `*`
.replace(/[*$]/g, "\\$&") // escape all `*` nad `$` (math)

This comment has been minimized.

@j-f1

j-f1 Sep 4, 2018

Member

s/nad/and/?

Show resolved Hide resolved src/language-markdown/printer-markdown.js
@j-f1

j-f1 approved these changes Sep 4, 2018

@ikatyang ikatyang merged commit a1545a8 into prettier:master Sep 5, 2018

10 checks passed

ci/circleci: build_prod Your tests passed on CircleCI!
Details
ci/circleci: checkout_code Your tests passed on CircleCI!
Details
ci/circleci: test_prod_node4 Your tests passed on CircleCI!
Details
ci/circleci: test_prod_node9 Your tests passed on CircleCI!
Details
ci/circleci: test_prod_standalone Your tests passed on CircleCI!
Details
codecov/patch 100% of diff hit (target 80%)
Details
codecov/project 96.55% (+<.01%) compared to 50c9115
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

@ikatyang ikatyang deleted the ikatyang:feat/markdown-preserve-math branch Sep 5, 2018

@ikatyang ikatyang added this to the 1.15 milestone Oct 25, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment