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

Math rendering in documentation: migrate to MathJax or KaTeX? #328

Open
stestoll opened this issue Feb 17, 2024 · 0 comments
Open

Math rendering in documentation: migrate to MathJax or KaTeX? #328

stestoll opened this issue Feb 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@stestoll
Copy link
Member

Currently, EasySpin uses a home-grown system to generate images from LaTeX equations embedded inside <!--MATH --> comments in the HTML files. These are compiled using the doc builder script.

This has several disadvantages:

  • Rendering issues. The currently produced png image files result in displays where the math is not properly lined up with the text. Zooming reveals that the math is pixelated.
  • Need for a documentation build step.

There are two excellent web math rendering packages available: MathJax and KaTex. We should evaluate whether to migrate to one of these.

@stestoll stestoll added the documentation Improvements or additions to documentation label Feb 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant