如何在我的 github 存储库中使用 pdf 文件作为自述文件？答案

【问题标题】：How can I use a pdf file as the readme in my github repo?如何在我的 github 存储库中使用 pdf 文件作为自述文件？
【发布时间】：2016-10-16 00:38:49
【问题描述】：

我有一个由 Latex 生成的 pdf 文件，其中包含许多方程式，什么都没有。我想将此 pdf 用作我的 github 存储库中的 readme.md 文件。我该怎么做？

或者，是否可以直接将 tex 文件集成到 github 并将其用作自述文件而不是 pdf 版本？ github 是否允许任何与乳胶语法的集成，例如 gmail？

【问题讨论】：

您可以将其转换为图像并将其放在 README.md 中，但不是很优雅。最好只转换方程式部分。
看看这个：webapps.stackexchange.com/questions/48061/…
如果我正在访问一个包含复杂（并且可能很广泛）文档的项目，我不希望在 README 区域中显示复杂的文档。相反，我建议您只需在自述文件中总结您的项目，并为编译、设置、运行或任何必要的事情提供足够的详细信息。然后，提供 PDF（更易于阅读）作为单独下载。我也不想看到我的浏览器下载并渲染复杂的 PDF，而是使用我最喜欢的 PDF 查看器。
我认为，你想要的并不是真正可行的。 readme.md 只是降价。相反，尽量将其转换为 Markdown（但请参阅我的 previous comment），并链接到 PDF。
我明白你在第一条评论中的意思。你说的对;我同意。

【解决方案1】：

您无法将 PDF 作为自述文件导入，但我也看不出重点，因为它支持出色的 MD 语言，任何设备（也包括移动设备）都可以轻松查看。

我已经通过使用图像解决了方程问题。有一个不错的网站：http://mathurl.com/

只需输入您的乳胶方程式并点击“Make Math url”（左下角按钮），复制粘贴图片链接（红色）。

我在 github 的 wiki 中使用过它（但它应该与 readme.md 相同）：https://github.com/scholi/pySPM/wiki/Mass-calibration

享受吧！

【讨论】：