如何在Haddock文档中嵌入图像

Question

如何在本地Haddock文档中嵌入图像？

我看到例如the lens package只使用外部链接到图像，但我想在本地存储图像。

（这个问题与an (unanswered) question on the mailing list非常相似。）

Answer 1

如果您想在本地存储图像，可以：

-- A longer description of the package.
description: Some haskell package description.

    <<file:///home/user/your_image.png>>

结果：

如果您不想或不能通过相对路径添加图像，只需将图像名称放在没有完整路径的位置：

<<your_image.png>>

在这种情况下，您的图片必须位于project/docs目录中。

Answer 2

正如您引用的邮件列表主题中所述，一个选项是使用data URL将图像内嵌到文档中。它使源本身有点令人不愉快（因为它散布着大量的base64编码数据），尽管使用Haddock的named chunks可以帮助，方法是将所有图像放在文件末尾的命名块中。有关此方法的实际示例，请参阅Haddock documentation for the circle-packing package。

Answer 3

正如a blog post by Ian Ross中所述，您可以使用extra-doc-files cabal选项将额外文件捆绑到文档中。