blackode

blackode

Hi,
I generated Docs using the exdoc module.
The index.html is showing the images when I checked offline,but when I publish to the
HEX Package Manager images are not showing.
is anything to add more ?
if not possible with exdoc please specify an alternative.

Screenshot

Thanks in Advance :bouquet:

Showing Posts 1 to 5

NobbZ

NobbZ

As a workaround it should be possible to have the pictures hosted on an external service, eg github-pages. But of course you are right, it would be nice if hexdocs.pm would have better suipport or at least an official statement about this.

Perhgaps we pull @ericmj in here if this is worth to open an issue at Issues · hexpm/hexpm · GitHub or if this is by design?

ericmj

ericmj

Elixir Core Team

Images should work on hexdocs. Can you link to your project and show how you copied the images, generated the docs and added the images to the markdown?

blackode

blackode OP

I have added the image links in the @doc section while writing the definitions in the module and I used exdoc mix docs to generate the docs.
It generated a folder with doc and holding all the stuff files .
This is the github link
You can find the doc folder there.
Thanks for quick reply :bouquet:

ericmj

ericmj

Elixir Core Team

You need to put the images inside the doc/ directory. Hex only pushes things inside that directory to hexdocs [1], we do not traverse the markdown to resolve links to resources anywhere on your filesystem. You might also want to copy the images inside an alias [2] on the docs task that runs after ex_doc to ensure that ex_doc does not overwrite the directory:

defp aliases do
  [docs: ["docs", &copy_images/1]]
end

defp copy_images(_) do
  File.cp! ...
end

[1] Hex v2.5.0 — Documentation
[2] Mix — Mix v1.20.2

10
Post #4
blackode

blackode OP

Thanks for the quick response. The above one only works to copy contents of one file to another.After looking into more with your suggestions I found the follwing code snippets which copy the contents of source to destination in the official docs

defp copy_images(_) do
   File.cp_r "source", "destination", fn(source, destination) ->
   IO.gets("Overwriting #{destination} by #{source}. Type y to confirm. ") == "y\n"
   end
end

That really solved the problem. Thanks for that amazing stuff. Now Images are shown in the docs.
The Printex Documentation
:bouquet: :bouquet: Once again Thanks a lot.

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
kpanic
Hi everyone, I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding. I sta...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New
apz
I’m new to elixir and just tried to install the elixirLS extension for VScode(ium) and it is throwing some errors that I would like help ...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews