This crate contains no functionality, it is merely a demonstration of how to use
embed-doc-image to embed images local to the
repository that work across both docs.rs and
local documentation. The motivation for this crate is
rustdoc’s inability to include local images
in a way that consistently works across local copies of the repository and
See the documentation for more information. In addition, you are encouraged to browse the source code for this showcase crate to see a fleshed out example of how the solution works.
In addition to serving as a showcase, this crate is used to verify that the solution indeed
works across both local installations and
This is necessary because a proc macro crate cannot use its own macros in its own documentation.
embed-doc-image should work across the usual web-supported file types
(jpg, png, svg, gif, bmp). If you find that it does not work with your files, please
file an issue.
The below Ferris images are courtesy of rustacean.net.
Test that images render in module docs.
Test that images render in macro docs.
Test that images render in struct docs.
Test that images render in trait docs.
Test that images render in function docs.
Test that images render in type docs.