#image #docs #embed #showcase #ferris #original #embed-doc-image

embed-doc-image-showcase

embed-doc-images 库的展示

3 个版本

0.1.2 2021年5月26日
0.1.1 2021年5月26日
0.1.0 2021年5月26日

#2 in #showcase

MIT 许可证

51KB
56 行代码(不含注释)

embed-doc-image-showcase

这个 crate 是 embed-doc-image 库的展示。

请参考 docs.rs 上的文档以查看其使用示例。


lib.rs:

embed-doc-image 的展示。

这个 crate 不包含任何功能,它仅是演示如何使用 embed-doc-image 将本地仓库中的图像嵌入到库中,使其在 docs.rs 和本地文档中都能正常工作。这个 crate 的动机是解决 rustdoc 无法在仓库的本地副本和 docs.rs 中一致地包含本地图像 的问题。

请参考文档获取更多信息。此外,鼓励您浏览这个展示 crate 的源代码,以了解解决方案的工作原理。

除了作为展示外,这个 crate 还用于验证解决方案是否确实可以在本地安装和 docs.rs 中工作。这是因为一个 proc macro crate 不能在其自己的文档中使用其自己的宏。

embed-doc-image 应该支持常规的网页支持的文件类型(jpg, png, svg, gif, bmp)。如果您发现它无法与您的文件一起工作,请提交问题。

以下 Ferris 图像是来自 rustacean.net

![原始 Ferris][ferris]

![Ferris 做手势][ferris-gesture]

![Corro][corro]

![跳舞的 Ferris][dancing-ferris]

依赖

~1.5MB
~40K SLoC