有没有办法在README中渲染LaTex ?md在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
其他回答
你也可以使用这个在线编辑器:https://www.codecogs.com/latex/eqneditor.php,它可以动态生成SVG文件。你可以像这样在你的文档中添加一个链接: ,结果是: .
好消息! 根据这篇博文,现在GitHub在自述文件中支持Mathjax。
可以使用$分隔符使用内联LaTeX语法,或者使用$$分隔符使用块内语法。
我刚刚发布了一个新版本的xhub,这是一个浏览器扩展,可以在GitHub页面中渲染LaTeX(和其他东西)。
缺点:
你必须安装扩展一次。
优点:
不需要设置任何东西。 用数学写下Markdown 显示数学: ' '的数学 E ^{i\pi} + 1 = 0 ' ' ' 直线数学$ ' a^2 + b^2 = c^2 ' (语法类似于GitLab。) 工作的明暗背景。(数学有文字颜色) 你可以像复制粘贴文本一样复制粘贴数学
作为一个例子,看看这个GitHub README:
对于推送到GitHub的自动转换,看看TeXify应用程序:
GitHub应用程序,在你的推文件扩展名*.tex。md和渲染它的TeX表达式为SVG图像
它是如何工作的(从源存储库):
每当你按TeXify将运行并搜索*.tex。Md文件。对于其中的每一个,它将运行readme2tex,它将接受美元符号之间的LaTeX表达式,将其转换为普通的SVG图像,然后将输出保存到.md扩展文件中(这意味着将处理名为README.tex.md的文件,并将输出保存为README.md)。在此之后,将提交输出文件和新的SVG图像并将其推回您的repo。
编辑:正如锗指出的那样,它对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">
完成了!。通过加载页面查看你的等式。
推荐文章
- 了解Git和GitHub的基础知识
- 在GitHub上有一个公共回购的私人分支?
- 只用GitHub动作在特定分支上运行作业
- Git合并与强制覆盖
- 是否有一个链接到GitHub下载文件的最新版本的存储库?
- GitHub -致命:无法读取用户名https://github.com':没有这样的文件或目录
- Github:我能看到回购的下载数量吗?
- 我如何确定文件编码在OS X?
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌