python - MkDocs和MathJax

我是MkDocs的新手，正在写一些需要 latex 的技术文档。我已经成功建立了一个具有MkDocs主题之一的小型网站，但是该网站无法正确显示 latex 方程式。我遵循以下指示:

http://www.vlfeat.org/matconvnet/developers/

以及该页面上python-markdown-mathjax链接后面的说明。我还修改了一些适当的行到我的mkdocs.yaml文件中，类似于:

https://github.com/EdyJ/vehicle-physics-docs/blob/master/mkdocs.yml

但是，发出命令“mkdocs build”仍然会导致站点无法呈现等式。我还尝试了在mkdocs build命令中添加-x mathjax标志。

我搜寻了网络，并且已经花了很多时间进行修补。谁能阐明我要让这两个人一起玩需要做什么？

最佳答案

这实际上比我预期的要容易。首先，我安装了Python-Markdown-Math Extension:

pip install https://github.com/mitya57/python-markdown-math/archive/master.zip

然后，我创建了一个新的MkDocs项目:

mkdocs new test_math

接下来，我将test_math/docs/index.md文件编辑如下(从MathJax documentation借来的样本):

# MathJax Test Page

When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are
$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$

最后，我将test_math/config.yaml文件编辑如下:

site_name: Test Math

extra_javascript:
    - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML

markdown_extensions:
    - mdx_math

我不确定这是否行得通，但是我运行了测试服务器以查看:

mkdocs serve

然后，我打开浏览器并加载http://127.0.0.1:8000/。显示带有正确格式的样本方程式的页面:

然后，我记得OP要求它与ReadTheDocs一起使用，因此我将以下行添加到配置中:

theme: readthedocs

我的浏览器重新加载，并显示以下(正确格式的方程式):

我应该注意，我收到一些关于fontawesome无法加载的奇怪错误。以MkdDocs为主题，方程式在一分钟后消失(当错误出现在浏览器的控制台中时)。但是，在ReadTheDocs主题中，即使出现错误，方程也可以正确显示。无论哪种方式，我都认为此错误与本地计算机上的其他问题有关。

最后，赏金是...

我通常不做广告，但是自从您问起以来，我是Python-Markdown的首席开发人员，我经常与mitya57(Python-Markdown-Math Extension的创建者)合作，因为他是另外两个具有提交访问权限的开发人员之一我是MkDocs的贡献者(其中之一是对Python-Markdown扩展的支持)。

关于python - MkDocs和MathJax，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/27882261/

Mkdocs

python - MkDocs和MathJax