How can I use katex from my md file?

[manuelgomezrico]

Hi
I have writed the following formula in my md file from visual studio code:

$$RRMSE= \sqrt{\dfrac{1}{n} * \displaystyle\sum_{i=1}^n\dfrac{(y_i-\tilde{\bar{y_i})^2}}{y_i}}$$

And I see it in visual code very well

When I upload this rm file to project github, I see again:
$$RRMSE= \sqrt{\dfrac{1}{n} * \displaystyle\sum_{i=1}^n\dfrac{(y_i-\tilde{\bar{y_i})^2}}{y_i}}$$
I want to se the formula of image, could you help me,please?

Thanks

[edemaine]

Github's Markdown renderer does not support KaTeX. I believe you can use Github Pages, which uses Jekyll, with suitable plugins, but there's no way to get READMEs etc. to directly render mathematics, I'm afraid.

[manuelgomezrico]

Ok, thanks for your answer
So I'm sad because I did one formula so cool from visual studio code :(

[manuelgomezrico]

Hi again
I have the solution the problem
If you render the formula in img object, you can see the formula in radme.md without problem
Example:

The img object, in src attribute, you have to write the formula:
img src
"https://render.githubusercontent.com/render/math?math=RRMSE=%20\sqrt{\dfrac{1}{n}%20*%20\displaystyle\sum_{i=1}^n\dfrac{(y_i-\tilde{\bar{y_i})^2}}{y_i}}"
Then I can use this plugin in local (Visual Studio Code) and after I have to render it in img object (project Github)
Regards

[edemaine]

Thanks, I didn't know about https://gist.github.com/a-rodin/fef3f543412d6e1ec5b6cf55bf197d7b — quite interesting. Unfortunately, it doesn't work well in dark mode (I see black text on an almost-black background).

[manuelgomezrico]

if you use this attribute stype in object img like --> style="background: white;"
Is possible that you can have solution. What do you think about this?

[pdmosses]

I'm experimenting with using KaTeX in Markdown pages – see my test site. The KaTeX markup is rendered in the browser, so there is no need to upload any images; it works in dark mode too (try the Preview button on this page).

The test site is built and hosted on Github Pages, and (as @edemaine mentioned) Github Pages uses Jekyll. By default, Jekyll uses kramdown to convert (a variant of) Markdown to HTML, and you can use KaTeX markup in kramdown's math blocks, without needing to escape special characters.

The only configuration required to enable use of KaTeX on the test site was to include the usual links and scripts in the head element of the relevant pages. For the Jekyll theme that I'm using (Just the Docs) that involved adding a single file, and adding math: katex in the front matter on pages with math blocks.

No extra plugins were required. You can also run Jekyll locally to build your site (independently of Github Pages) or use kramdown directly.