发表新帖
发表新帖

How to support latex in github-pages?

前端 未结
关注
4 1354
孤城傲影
孤城傲影 2020-12-22 16:04

I use jekyll to write post and show it in github-pages. My source file is writen with markdown.

How can I insert formula into the markdown file?

相关标签:
4条回答
  • 孤街浪徒
    2020-12-22 16:21

    If you used Jekyll in your GitHub pages, you can add

      <script type="text/x-mathjax-config">
    MathJax.Hub.Config({
      tex2jax: {
        skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
        inlineMath: [['$','$']]
      }
    });
  </script>
  <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>

    in the file _includes/head.html, and then your GitHub Pages site will support MathJax

    0 讨论(0)
  • 情话喂你
    2020-12-22 16:31

    The best way right now IMO is to use the MathJax backend (which is part of kramdown, i.e. available on GitHub Pages) and then use KaTeX on the frontend for rendering. KaTeX is more lightweight and faster than MathJax, which makes it a better fit for a blog theme.

    I'm using this technique with great success for my Jekyll theme Hydejack. Feel free to use it on your own site, by doing the following:

    In config.yml, set the math engine to mathjax:

    kramdown:
  math_engine: mathjax

    Add KaTeX to your site and also make sure the following code runs sometime after it has loaded.

    const mathBlocks = document.querySelectorAll('script[type^="math/tex"]');
Array.from(mathBlocks).forEach((el) => {
  const tex = el.textContent.replace("% <![CDATA[", "").replace("%]]>", "");
  el.outerHTML = window.katex.renderToString(tex, {
    displayMode: el.type === "math/tex; mode=display",
  });
});

    The actual code I'm using is slightly more complicated. You can check it out on GitHub.

    0 讨论(0)
  • 猫巷女王i
    2020-12-22 16:34

    The easiest way to do this right now is to use the KaTeX auto-render extension.

    Simply drop the following into your <head>:

    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.css" integrity="sha384-yFRtMMDnQtDRO8rLpMIKrtPCD5jdktao2TV19YiZYWMDkUR5GQZR/NOVTdquEx1j" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/katex.min.js" integrity="sha384-9Nhn55MVVN0/4OFx7EE5kpFBPsEMZxKTCnA+4fqDmg12eCTqGi6+BB2LjY8brQxJ" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.10.2/dist/contrib/auto-render.min.js" integrity="sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>

    Note that this assumes the following delimiters appear in your HTML:

    $$\LaTeX code$$   (for display)
\\[\LaTeX code\\] (also for display)
\\(\LaTeX code\\) (for inline)

    Note, if using Jekyll, you will need to have the following in your _config.yml:

    markdown: kramdown
kramdown:
    math_engine: katex

    WARNING: Do not use math_engine: mathjax. It will break this by automatically removing the LaTeX delimiters.

    0 讨论(0)
  • 暖寄归人
    2020-12-22 16:36

    Since resources online have changed regarding this question, here's an update on supporting LateX with GitHub Pages.

    Note that the closest to Latex rendering without exporting as images and natively supporting it on your Jekyll site would be to use MathJax.

    MathJax is actually recommended in Jekyllrb docs for math support, with Kramdown, it also converts it from LaTeX to PNG, more details on it here at the Kramdown documentation

    Option 1: Write your equation in MathURL and embed it.

    You could write the equation with MathURL, then generate a url that permanently points to the equation, and display this in an <iframe> tag. However, this will stop working if MathURL goes offline.

    Option 2: Implement jsMath

    jsMath will allow almost LateX like syntax and will be supported in your blog if you have set it up correctly, there is extensive documentation on this.

    Option 3: Mathjax (by far the easiest in my opinion)

    Many sites have mentioned that Mathjax is considered a successor of jsMath, and is much easier to implement with Jekyll. MathJax is also used by mathematics.stackexchange.com too!

    • Step 1: Have your site load the script in sites where you want to display math. (usually done in the header)

    • Optional: Check your markdown parser in _config.yml. redcarpet or kramdown is suggested in this example. Certain parsers like discount will interfere with the syntax but I have a solution below.

    • Step 2: Write your equations.

    Quoting this tutorial by Gaston Sanchez:

    MathJax does not have the exactly same behavior as LaTeX. By default, the tex2jax preprocessor defines the LaTeX math delimiters, which are \(...\) for in-line math, and \[...\] for displayed equations. It also defines the TeX delimiters $$...$$ for displayed equations, but it does not define $...$ as in-line math delimiters.

    Read the documentation on the syntax for more details.

    • Note: Using the raw liquid tag to ensure Markdown parsers do not interfere with MathJax syntax.
    • While you could escape backslashes (e.g. \\[ \frac{1}{n^{2}} \\])to ensure they are parsed properly, as described by Chistopher Poole's tutorial, this is not always intuitive and looks complicated. A simpler solution would be to use the raw liquid tag to ensure the text is ignored by the Markdown processor and directly output as a static html. This is done with {% raw %}and also {% endraw %}

    Here is a code sample:

     {% raw %}
  $$a^2 + b^2 = c^2$$ --> note that all equations between these tags will not need escaping! 
 {% endraw %}

    Lastly also ensure that the fonts support displaying LateX as some have issues like font size being too small. Alternatively here are some additional methods like Google Charts and MathML discussed in the latex StackExchange sister site.

    0 讨论(0)
 看不清?
提交回复
热议问题