有没有办法在README中渲染LaTex ?md在GitHub存储库?我在谷歌上搜索了堆栈溢出,但没有一个相关的答案似乎可行。
当前回答
对于简短的表达式和不那么花哨的数学,您可以使用内联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下一种方式:



其他回答
自述文件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
如果你对https://www.codecogs.com/latex/eqneditor.php有问题,我发现https://alexanderrodin.com/github-latex-markdown/对我有用。它生成您需要的Markdown代码,因此您只需将其剪切并粘贴到README中。md文档。
你也可以使用这个在线编辑器:https://www.codecogs.com/latex/eqneditor.php,它可以动态生成SVG文件。你可以像这样在你的文档中添加一个链接: ,结果是: .
对于简短的表达式和不那么花哨的数学,您可以使用内联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下一种方式:



好消息! 根据这篇博文,现在GitHub在自述文件中支持Mathjax。
可以使用$分隔符使用内联LaTeX语法,或者使用$$分隔符使用块内语法。
推荐文章
- GitHub上的分叉和克隆有什么区别?
- 在LaTeX中突出显示源代码
- 如何将现有的解决方案从Visual Studio 2013添加到GitHub
- 是否可以在GitHub上搜索特定的文件名?
- 如何将LaTeX与Markdown混合?
- GitHub -未能连接到GitHub 443 windows/连接到GitHub失败-无错误
- 我怎么能让詹金斯CI与Git触发器推到主人?
- 在LaTeX中出现“Missing $ inserted”错误
- 如何从拉请求中删除提交
- 如何用分发文件发布npm包?
- 如何同步项目到GitHub与Android工作室?
- 跟踪在GitHub上创建的一个新的远程分支
- 如何将一个特定的提交从一个分支合并到Git中的另一个分支?
- 从pull请求中删除一个修改过的文件
- 下载GitHub项目的最快方式