remarkjs / remark-math

remark and rehype plugins to support math
https://remark.js.org
MIT License
380 stars 57 forks source link

Refactor Wording, few details on syntax in readme #79

Closed pjkaufman closed 2 years ago

pjkaufman commented 2 years ago

Initial checklist

Description of changes

Updated some minor wording changes and clarified that a math block needs a newline character in it or else it will not be a math block.

Here is the example of it not being a math block if it is only 1 line but multiple dollar signs: https://astexplorer.net/#/gist/111c4f5728f9c80696a9422a7c9c99f0/aa4f9e212560494d7ebb5d826e6777137afa59d1

Here are the contents of the AST example just in case it is not the same as what I intended for the above link:

$$$L = \frac{1}{2} \rho v^2 S C_L$$$

$$
Math block
$$
github-actions[bot] commented 2 years ago

Hi! It seems you removed the template which we require. Here are our templates (pick the one you want to use and click *raw* to see its source):

I won’t send you any further notifications about this, but I’ll keep on updating this comment, and hide it when done!

Thanks, — bb

codecov-commenter commented 2 years ago

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage :thumbsup:

Coverage data is based on head (8a900d7) compared to base (f4596b4). Patch has no changes to coverable lines.

:exclamation: Current head 8a900d7 differs from pull request most recent head f06800c. Consider uploading reports for the commit f06800c to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #79 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 9 9 Lines 412 412 ========================================= Hits 412 412 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=remarkjs). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=remarkjs)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

pjkaufman commented 2 years ago

Nice, thanks. I think the text is good!

What do you think about how this section reads when rendered? https://github.com/remarkjs/remark-math/blob/f06800c160c3f2c486a301b8c112b87077a6ba63/packages/remark-math/readme.md#syntax

To me, it feels a bit crowded. Going back and forth. Reading a bit confusing.

One idea as pseudotext:

This plugin […] the syntax. The syntax […] blocks. See ~~its~~the extension’s readme for parse details:

* micromark-extension-math

> 👉 **Note**: `$math$` […] `a b$}$$`

> 👉 **Note**: Like code […] line endings:
>
> ```markdown
> […]
> ```

Personally I think that either is fine so long as we pick one and go with it.

wooorm commented 2 years ago

Alright! If you don‘t mind, can you then apply it? I think it’s a small improvement. So, moving the Like code […] line endings into a “Note”.

pjkaufman commented 2 years ago

I can definitely see about applying it. But that will likely be later today since I don't have too much time to do so today.

pjkaufman commented 2 years ago

The change should now be present.

github-actions[bot] commented 2 years ago

Hi! This was closed. Team: If this was merged, please describe when this is likely to be released. Otherwise, please add one of the no/* labels.

wooorm commented 2 years ago

Thanks Peter!