自述文件2Tex

我一直在写一个脚本，它可以自动地把LaTeX排版很好地转换成github风格的markdown: https://github.com/leegao/readme2tex

在Github上渲染LaTeX有一些挑战。首先，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}或$$…$$)居中。这使得那些已经习惯使用LaTeX的人可以很容易地保持工作效率。

如果这听起来有帮助，一定要去看看。https://github.com/leegao/readme2tex

对于简短的表达式和不那么花哨的数学，您可以使用内联HTML在codecogs上获得乳胶渲染的数学，然后嵌入生成的图像。这里有一个例子:

- <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 markdown下一种方式:

![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)

编辑:正如锗指出的那样，它对README不起作用。Md但其他git页面，虽然没有解释可用。 我的快速解决方案是这样的

步骤1。将latex添加到.md文件中

$$x=\sqrt{2}$$

注意:数学公式必须在$$…$$或\\(…\ \)。

步骤2。将以下代码添加到scripts.html或主题文件中(将此代码附加在末尾)

<script type="text/javascript" async

src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">

完成了!。通过加载页面查看你的等式。

你也可以使用这个在线编辑器:https://www.codecogs.com/latex/eqneditor.php，它可以动态生成SVG文件。你可以像这样在你的文档中添加一个链接: ，结果是: ．

我一直在四处寻找，发现另一个问题中的这个答案最适合我。即使用githubcontent数学渲染器，例如显示:

使用这个链接 小心乳胶需要url编码，但其他工作对我来说很好。

自2022年5月以来，这已得到官方支持:

内联:

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

块:

Where
$$x = 0$$

Evaluate
$$x + 1$$