Github 使用 MathJax 在 colab 笔记本中渲染 bash 脚本,而它不应该

Github renders bash script in the colab notebook with MathJax while it should not

提问人:Anton 提问时间:10/26/2023 最后编辑:Anton 更新时间:11/2/2023 访问量:90

问:

我在 Google Colab 笔记本中有一个单元格,保存在 github 存储库中。该笔记本中的某些单元格和其他一些笔记本在 github 浏览中未正确呈现。

单元格的实际代码为:

!redis-cli $REDIS_CONN PING
!redis-cli $REDIS_CONN SET hello world
!redis-cli $REDIS_CONN GET hello

但随后它在 GitHub 视图中呈现,它搞砸了(见下图)。

问题只是出在 github 视图上 - 本地 git 克隆或“在 colab 中打开”后的实际代码仍然可以。

enter image description here

原始文件是通过 Colab->Save a 副本在 Github 中创建的,但在我使用 VSCode 在本地更改代码并提交更改后仍然存在。

我在这里做错了什么,或者有什么解决方法可以使其正确渲染吗?

更新:经过一番挖掘,似乎两个美元符号之间的字符串被解释为数学表达式,并由 GitHub 预览版使用 MathJax 呈现。实际上,您可以右键单击错误渲染的部分,它将显示MathJax菜单。所以问题变成了:

如何在 GitHub 笔记本预览版中有选择地禁用 MathJax 渲染?

GitHub Jupyter-Notebook google-colaboratory mathjax

评论


答:

0赞 VonC 10/30/2023 #1

如何在 GitHub 笔记本预览版中有选择地禁用 MathJax 渲染?

GitHub 的 Jupyter Notebook 查看器似乎将美元符号之间的文本视为 LaTeX 表达式,这是使用 MathJax 渲染数学表达式的常用语法。

我得到的最接近的是 ](https://github.com/VonC/Redis-Workshops/blob/patch-1/00-Setup/00-Setup_Redis_Workshops.ipynb?short_path=d49a1f8#L167-L170 中的百分比编码$00-Setup_Redis_Workshops.ipynb)

      "source": [
        "!redis-cli %24{REDIS_CONN} PING\n",
        "!redis-cli %24{REDIS_CONN} SET hello world\n",
        "!redis-cli %24{REDIS_CONN} GET hello"
      ]

它不会在常规 GitHub 视图中呈现:$

GitHub view

协作视图中也不行

Collab view

但至少,它更容易阅读/解释。

评论

0赞 Anton 10/31/2023
元数据类型为 。HEre 是整个区块的链接:github.com/antonum/Redis-Workshops/blob/......在代码中添加反引号没有帮助。Cell 现在触发错误,github 预览格式仍然无效。将每行一个单元格拆分为单独的单元格有助于渲染,但这不是我在这里准备做的事情。code
0赞 VonC 10/31/2023
@Anton好的,我已经编辑了答案,添加了一些建议供您尝试。
0赞 Anton 10/31/2023
这些选项都无济于事。似乎是 github 第一次看到美元符号 - 渲染搞砸了。!、%、%%bash <!-- Bash 命令 -->、单行 - 都具有相似(损坏)的结果。“Open in Colab”已经做了与nbviewer建议相同的操作,而且它实际上执行了整个操作。将命令放在外部文件中违背了笔记本的目的 - 将所有代码都打开并准备运行。
0赞 VonC 10/31/2023
@Anton好的,希望你的赏金能吸引更好的解决方案。
0赞 VonC 10/31/2023
@Anton我已经重写了答案,并留下了一些建议供您测试要禁用的 LaTeX 表达式。