haskell - 如何在 Haddock 文档中嵌入图像

Question

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

例如，我看到该lens包仅使用图像的外部链接，但我想将图像存储在本地。

（这个问题与邮件列表上的一个（未回答的）问题非常相似）。

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

正如您引用的邮件列表线程中所解释的，一种选择是使用数据 URL将图像内联到您的文档中。它使源本身读起来有点不愉快（因为它散布着大量的 base64 编码数据），尽管使用 Haddock 的命名块可以帮助，通过将所有图像放在文件末尾的命名块中。有关此方法的实际示例，请参阅circle-packing 包的 Haddock 文档。

Answer 3

正如Ian Ross 在博客文章中所解释的，您可以使用extra-doc-filescabal 选项将额外文件捆绑到文档中。