-
|
I am experiencing an issue with using MathJax for formulas within my documentation. Problem: When I navigate to a page, the formulas do not render immediately. Instead, the space designated for these formulas remains blank upon the first load. Interestingly, when I refresh the page, the formulas then appear as expected. Is there a solution available to ensure that the formulas render properly upon the initial page load, eliminating the need for a refresh each time? |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments 4 replies
-
|
the above happens when using: $$ {whatever} $$. also: this issue does not occur all the time but quite frequently. |
Beta Was this translation helpful? Give feedback.
-
|
Looks like there is some sort of incompatibility with MathJax in MKDocs' markdown that using directly the javascript causes some quirks. I just noticed that there is a dedicated plugin mentioned in MKDocs Material' docs, so I added it in mkdocs.yml and it fixed the problems I had: markdown_extensions:
pymdownx.arithmatex:
generic: true |
Beta Was this translation helpful? Give feedback.
-
|
More specifically, unless you actively preserve the MatJax code, the Markdown parser can transform it, breaking MathJax's ability to render it properly. The mention extension actively preserves that content such that it makes it all the way to HTML without getting erroneously treated like Markdown code. |
Beta Was this translation helpful? Give feedback.
-
This didn't happen, in my case, when using Jekyll and after porting the site to MKDocs wasn't that obvious to me that I needed some markdown plugin/extension to work with MathJax; this because I'm still "new"/not familiar with MKDocs yet and also I'm a bit reluctant towards using plugins in general. It would be nice to have some "Troubleshoot/FAQ" page in MKDocs user documentation, linked in the menu, that points to some resolutions, like in this case when working with some JS library or missing feature, to point to the plugins page, which has in turn a link to the catalog repo. |
Beta Was this translation helpful? Give feedback.
-
|
I also encountered this problem, and my solution is as follows. At first, my config is After closing the "instant" feature, I no longer need to refresh the page for the formulas to display correctly. Here are my other configurations, which are the same as those in the website |
Beta Was this translation helpful? Give feedback.
-
|
this seems to work. thank you very much! |
Beta Was this translation helpful? Give feedback.
-
|
Thank you so much. Took me hours before finding this. Should be added in the docs for the mathjax configuration. |
Beta Was this translation helpful? Give feedback.
I also encountered this problem, and my solution is as follows.
At first, my config is
After closing the "instant" feature, I no longer need to refresh the page for the formulas to display correctly.
Here are my other configurations, which are the same as those in the website