有没有办法在README中渲染LaTex ?md在GitHub存储库?我在谷歌上搜索了堆栈溢出,但没有一个相关的答案似乎可行。
当前回答
如果你对https://www.codecogs.com/latex/eqneditor.php有问题,我发现https://alexanderrodin.com/github-latex-markdown/对我有用。它生成您需要的Markdown代码,因此您只需将其剪切并粘贴到README中。md文档。
其他回答
自述文件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
我将带有方程式的存储库上传到Gitlab,因为它在.md文件中原生支持LaTeX:
```math
SE = \frac{\sigma}{\sqrt{n}}
```
内联latex的语法是$ ' \sqrt{2} ' $。
Gitlab使用JavaScript在浏览器中呈现方程,而不是显示图像,这提高了方程的质量。
更多信息请点击这里。
希望Github将来也能实现这个功能。
编写内联表达式:
这句话使用$分隔符来显示数学内联: $ \√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
我一直在四处寻找,发现另一个问题中的这个答案最适合我。即使用githubcontent数学渲染器,例如显示:
使用这个链接 小心乳胶需要url编码,但其他工作对我来说很好。
如果你对https://www.codecogs.com/latex/eqneditor.php有问题,我发现https://alexanderrodin.com/github-latex-markdown/对我有用。它生成您需要的Markdown代码,因此您只需将其剪切并粘贴到README中。md文档。
推荐文章
- 了解Git和GitHub的基础知识
- 在GitHub上有一个公共回购的私人分支?
- 只用GitHub动作在特定分支上运行作业
- Git合并与强制覆盖
- 是否有一个链接到GitHub下载文件的最新版本的存储库?
- GitHub -致命:无法读取用户名https://github.com':没有这样的文件或目录
- Github:我能看到回购的下载数量吗?
- 我如何确定文件编码在OS X?
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌