在Github上的README.md中进行乳胶渲染

Question

有没有办法在GitHub存储库中的README.md中呈现LaTex？我用谷歌搜索并搜索堆栈溢出但没有相关的答案似乎可行.

Answer 1

对于简短的表达而不是那么花哨的数学,你可以使用内联HTML在代码架上获得乳胶渲染数学,然后嵌入生成的图像.这是一个例子:

- <img src="https://latex.codecogs.com/gif.latex?O_t=\text { Onset event at time bin } t " /> 
- <img src="https://latex.codecogs.com/gif.latex?s=\text { sensor reading }  " /> 
- <img src="https://latex.codecogs.com/gif.latex?P(s | O_t )=\text { Probability of a sensor reading value when sleep onset is observed at a time bin } t " />

这会产生类似下一个的东西

更新:这在eclipse中效果很好但不幸的是在github中没有.唯一的解决方法是下一个:

拿你的乳胶方程式转到http://www.codecogs.com/latex/eqneditor.php,在显示公式的区域底部有一个小的下拉菜单,选择URL编码然后粘贴到你的下一步是github降价:

![equation](http://latex.codecogs.com/gif.latex?O_t%3D%5Ctext%20%7B%20Onset%20event%20at%20time%20bin%20%7D%20t)
![equation](http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7D) 
![equation](http://latex.codecogs.com/gif.latex?P%28s%20%7C%20O_t%20%29%3D%5Ctext%20%7B%20Probability%20of%20a%20sensor%20reading%20value%20when%20sleep%20onset%20is%20observed%20at%20a%20time%20bin%20%7D%20t)

Answer 2

自2022 年 5 月起，已正式支持：

排队：

Where $x = 0$, evaluate $x + 1$

块：

Where
$$x = 0$$

Evaluate
$$x + 1$$

Answer 3

Readme2Tex

我一直在研究一个脚本,它可以将LaTeX排版的大部分内容自动化为Github风格的降价:https://github.com/leegao/readme2tex

渲染LaTeX for Github有一些挑战.首先,Github风味的markdown剥离了大多数标签和大多数属性.这意味着没有基于Javascript的库(如Mathjax)或任何CSS样式.

然后,自然解决方案似乎是嵌入预编译方程的图像.但是,您很快就会意识到,LaTeX不仅仅是将美元符号封闭的公式转换成图像.

简单地嵌入来自在线编译器的图像会给文档带来非常不自然的外观.事实上,我认为它在你的日常x ^ 2数学俚语中比在跳跃时更具可读性.

我相信确保您的文档以自然和可读的方式排版非常重要.这就是为什么我编写了一个脚本,除了将公式编译成图像之外,还确保生成的图像正确匹配并与文本的其余部分对齐.

例如,以下是.md关于正则表达式排版的一些枚举属性的文件的摘录readme2tex:

正如您所料,顶部的方程组通过启动相应的align*环境来指定

**Theorem**: The translation $[\![e]\!]$ given by
\begin{align*}
...
\end{align*}
...

请注意,虽然内联方程($ ... $)与文本一起运行,但显示方程(由\begin{ENV}...\end{ENV}or 分隔的方程$$...$$)居中.这使已经习惯了LaTeX的人们能够轻松地保持工作效率.

如果这听起来像是可以帮助的东西,请务必检查出来.https://github.com/leegao/readme2tex

Answer 4

我的诀窍是使用Jupyter笔记本.

GitHub内置支持渲染.ipynb文件.您可以在笔记本中编写内联并显示LaTeX代码,GitHub将为您呈现.

这是一个示例笔记本文件:https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e

Answer 5

我将带有方程式的存储库上传到Gitlab，因为它对.md文件中的LaTeX具有本机支持：

```math
SE = \frac{\sigma}{\sqrt{n}}
```

内联乳胶的语法为$`\sqrt{2}`$。

Gitlab在浏览器中使用JavaScript渲染方程式，而不是显示图像，从而提高了方程式的质量。

更多信息在这里。

我们希望Github将来也能实现这一点。

Answer 6

也可以使用此在线编辑器：https : //www.codecogs.com/latex/eqneditor.php，它可以动态生成SVG文件。您可以在文档中放置如下链接 ![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2)： 。

Answer 7

我测试了其他人提出的一些解决方案，我想推荐agurodriguez在评论中创建和提出的TeXify，并由Tom Hale进一步描述-我想提出他的答案，并给出为什么这是一个很好的解决方案的原因：

• TeXify是包装Readme2Tex（中提及李回答）。要使用Readme2Tex，您必须在本地计算机上安装很多软件（python，latex等）-但是TeXify是github插件，因此您无需在本地计算机上安装任何软件 -您只需要在线安装即可按下一个按钮，选择您的github帐户中的插件，然后选择TeXify将对其具有读写访问权限的存储库，以解析您的tex公式并生成图片。
• 当您在存储库中创建或更新*.tex.md文件时，TeXify将检测更改并生成*.md文件，其中乳胶配方将通过保存在tex回购目录中的图片交换乳胶配方。因此，如果您创建README.tex.md文件，则TeXify将生成带有图片而不是tex公式的README.md。因此，解析tex公式并生成文档会在每次commit＆push时自动完成：)
• 因为您所有的公式都已更改为tex目录中的图片，并且README.md文件使用指向该图片的链接，所以您甚至可以卸载TeXify，并且所有旧文档仍然可以使用 :)。该tex目录和*.tex.md文件将留在库中，所以你必须访问原始乳胶配方和图片（你也可以安全地存储tex目录下的“手工制作”的其他文档图片- TeXify不会去碰它们）。
• 您可以在README.tex.md文件中直接使用方程式乳胶语法（不松动.md markdown语法），这非常方便。Julii在他的回答中建议使用特殊的链接（带有公式）到外部服务，例如。http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7D但这很好，但是有一些缺点：链接中的公式不容易（方便）阅读和更新，并且如果该第三方服务有问题，您的旧文档将停止工作...在TeXify中，您的旧文档即使您卸载了该插件，它也将始终有效（因为从乳胶配方生成的所有图片都保留在tex目录中的存储库中）。
• 该宇超江在他的回答，建议使用Jupyter笔记本电脑，这也是不错的但是有索姆缺点：不能在README.md文件中直接使用公式，您需要到其他文件的链接有* .ipynb在回购其中包含胶乳（MathJax）公式。* .ipynb文件格式为JSON，不便于维护（例如，当您忘记将逗号放在适当的位置时，Gist不会在* .ipynb文件中显示行号的详细错误...）。

这是一些我的仓库的链接，在这些仓库中，我使用了TeXify，该文件是从README.tex.md文件生成的。

Answer 8

要在推送到GitHub时进行自动转换，请查看TeXify应用程序：

GitHub App查找推送带有扩展名* .tex.md的文件，并将其TeX表达式呈现为SVG图像

工作原理（来自源存储库）：

每当您按下TeXify时，它将在最后一次提交中运行并搜索* .tex.md文件。对于其中的每一个，它将运行readme2tex，它将使用放在美元符号之间的LaTeX表达式，将其转换为纯SVG图像，然后将输出保存到.md扩展文件（这意味着名为README.tex.md的文件将被处理，输出将另存为README.md。之后，输出文件和新的SVG映像将被提交并推送回您的仓库。