我该如何在我的GitHub仓库中使用PDF文件作为readme？ （如有不妥之处请指正）

Question

我有一个由Latex生成的pdf文件，其中有许多方程式等内容。我想将这个pdf作为我的github仓库的readme.md文件使用。我该怎么做？

或者，是否可以直接集成tex文件到github，并将其作为readme而不是pdf版本使用？ Github是否允许与例如Gmail一样利用latex语法进行集成？

- JRun

---

你可以将其转换为图像并放在README.md上，虽然这样不是很优雅。最好只转换方程的部分。 - Rogério Peixoto

看这个：http://webapps.stackexchange.com/questions/48061/can-i-trick-github-into-displaying-the-pdf-in-the-browser-instead-of-downloading - evan.oman

如果我要参观一个有复杂（可能比较广泛）文档的项目，我不希望在 README 区域中看到这些复杂的文档。相反，我建议您仅在 readme 中概述您的项目，并提供足够的详细信息以进行编译、设置、运行或其他必要操作。然后，作为单独的下载，提供 PDF 文件（更易阅读）。我也不想看到浏览器下载和渲染复杂的 PDF，而是使用我喜欢的 PDF 查看器。 - Martin Nyolt

我认为你想要的并不是真正可行的。readme.md只是一个markdown文件。相反，尽可能将其转换为markdown格式（但请参见我的先前评论），然后链接到PDF文件。 - Martin Nyolt

我明白你在第一条评论中的意思。你是对的，我同意。 - JRun

我在维基百科中使用了方程式。技巧是为其创建外部图像。我使用http://mathurl.com/来创建PNG文件。然后，您可以将它们作为外部图像放入readme.md中。这里有一个示例：https://github.com/scholi/pySPM/wiki/Mass-calibration - scholi

Answer 1

您不能将PDF作为自述文件导入，但我认为这没有意义，因为它支持美妙的MD语言，可以在任何设备上轻松查看（包括移动设备）。

我已经通过使用图像解决了方程问题。有一个很好的网站可以实现这一点：http://mathurl.com/。

只需输入您的LaTeX方程式，然后单击“Make Math url”（左下角按钮），复制并粘贴图像链接（红色）即可。

我已在github的维基中使用它（但它应该与readme.md同样有效）：https://github.com/scholi/pySPM/wiki/Mass-calibration 享受吧！

- scholi

---

问题是，我有一个带图片的docx文档，但转换成markdown格式根本行不通。这浪费了太多时间，而且失败了。 - Gulzar

然后，也许可以将你的文档做成markdown格式，并在之后将其转换为docx格式。用户真的很欣赏能够无需打开文档（特别是可能携带病毒的docx文件）就能查看自述文件的方便。 - scholi

Github的Markdown文件不支持像KaTex这样的方程式库。 - Jonas Grønbek