Search code examples
githubmarkdownkatex

How to show KaTex - output on GitHub README.md file?


I am completely new to markdown and I am using typora to edit and create markdown files.In my editor I have using the following code

$$
\textcolor{aqua}{\boxed{\pmb{\mathscr{\text{Statement 1} \Rightarrow\begin{cases}
&\text{Statement 2 }\Omicron(anything)\\
&\text{Statement 3 }\Gamma(anything)
\end{cases}}}}}
$$

which shows the following result enter image description here

but in github readme preview it shows like

$$ \textcolor{aqua}{\boxed{\mathscr{\pmb{\text{Statement 1} \Rightarrow [\begin{cases} &\text{Statement  }\Omicron (anything)\ &\text{Statement 3 }\Gamma (anything)\ \end{cases}]}}}} $$

Is there any way to achieve desired output so that it shows like what the given picture shows. I can use image instead of using katex codeblock. But I don't want to use image.


Solution

  • GitHub itself, through its GFM (GitHub Flavored Markdown Spec) does not support Katex

    You would need for your GitHub repositories to be a GitHub Pages project in order to include for instance a Jekyll plugin like linjer/jekyll-katex, in order for those pages to represent a Katex section properly.
    See also "How to Create A Jekyll Page With KaTeX" from Neal Dawson-Elli.