自述文件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

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

内联:

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

块:

Where
$$x = 0$$

Evaluate
$$x + 1$$

自述文件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

编辑:正如锗指出的那样，它对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">

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

我的诀窍是用木星笔记本。

GitHub内置了呈现.ipynb文件的支持。你可以编写内联的LaTeX代码并在笔记本中显示，GitHub会为你呈现它。

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

编写内联表达式:

这句话使用$分隔符来显示数学内联: $ \√6 {3 x - 1} + (1 + x) ^ 2美元

将表达式写成块:

柯西-施瓦茨不等式 $ $ \离开(\ sum_ {k = 1} ^ n a_k b_k \右)^ 2左(\ \ leq \ sum_ {k = 1} ^ n a_k ^ 2 \右)\左(\sum {k=1}^n b_k^2 \右)$$

来源:https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions