您如何链接到 README.rst 中文档文件夹中的图像?



我正在努力寻找一种方法来使用我的README.rst中的图像,这些图像将同时显示在github和PyPI上。

目前我正在使用以下标记:

.. image:: https://github.com/thebjorn/pydeps/blob/master/docs/_static/pydeps.svg

在 github (https://github.com/thebjorn/pydeps( 上看起来很棒,但在 PyPI (https://pypi.org/project/pydeps/1.6.0/( 上显示为断开的链接。

这是否可能,或者我需要将这些图像托管在其他地方?

你需要使用raw.githubusercontent.com而不是github.com

.. image:: https://github.com/thebjorn/pydeps/blob/master/docs/_static/pydeps-pylib.svg

只会在 Github 本身上正确呈现,而

.. image:: https://raw.githubusercontent.com/thebjorn/pydeps/master/docs/_static/pydeps-pylib.svg?sanitize=true

将在任何网站上呈现。


第一次尝试(损坏和删除(


第二次尝试:

  1. 正确替换 URL(也删除了路径中的blob部分 - 我的错!
  2. ?sanitize=true追加到要替换的每个 URL。

$ sed -i '' 's,.. image:: https://github.com/(.*)/blob/(.*).svg,.. image:: https://raw.githubusercontent.com/1/2.svg?sanitize=true,g' README.rst

在Github和TestPyPI上测试它,看起来都不错。


替代方法:使用 RawGit

另一种可能性是使用 RawGit,尽管缺点是这是第三方服务,因此当它关闭时,图像不会呈现,尽管可用。不过,为了完整起见:

$ sed -i '' 's,.. image:: https://github.com/(.*)/blob/(.*)$,.. image:: https://cdn.rawgit.com/1/2,g' README.rst

相关内容

  • 没有找到相关文章

最新更新