Skip to content
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

Use markdown mathematical notations #136

Open
3 tasks
tapaswenipathak opened this issue Jul 28, 2022 · 4 comments · May be fixed by #178
Open
3 tasks

Use markdown mathematical notations #136

tapaswenipathak opened this issue Jul 28, 2022 · 4 comments · May be fixed by #178
Labels
bug Something isn't working difficulty: easy first-timers-only good first issue Good for newcomers

Comments

@tapaswenipathak
Copy link
Contributor

  • Chemical compound formulae in Glossary
  • Distinguish b/w $MS^1$ (not MS(1)), $MS^2$ (not MS(2)), MS/MS
  • Mathematical expressions in tuts

Ref:

  1. [doesn't work] https://github.blog/changelog/2022-06-28-fenced-block-syntax-for-mathematical-expressions/
  2. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions
  3. https://www.mathjax.org/

Use https://www.wolframalpha.com/ to learn more about mathematical notations:

Screenshot 2022-07-28 at 4 16 44 PM

@Vedant-rai
Copy link

Hi, this is my first commit to this repository. I would like to work on this issue. I am new to open-source so please let me know what changes you are expecting.

@rwst
Copy link

rwst commented Sep 2, 2022

Hi, just to clarify, the 1st link you give in Ref (as "not working") is about math display on GitHub and it works fine:
This sentence uses $ delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$

The problem is that you want math display on the OpenMS doc webpage not here on github so the link is actually not helpful.

Also the link to Wolfram Alpha is not helpful because, whatever they write, they will always propose their proprietary solution.

In addition to mathjax I'd recommend https://katex.org/. However, both require additional Javascript on the web site, so I think this issue is suited to beginners only when simple formulae are created using Unicode or HTML characters. If you want to have nice LaTeX formulas then SVG images or the abovementioned JS libraries are needed.

As you are using Sphinx mathjax (:math: ) should be directly supported.

@rwst
Copy link

rwst commented Sep 2, 2022

Using Sphinx mathjax actually works fine, example:
image

This was produced by inserting the code

:math:`a^2 + b^2 = c^2`

@Telomelonia Telomelonia linked a pull request Dec 5, 2022 that will close this issue
14 tasks
@Telomelonia
Copy link

@tapaswenipathak
I have created a draft PR pls have a look at it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working difficulty: easy first-timers-only good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants