# Images in documentation

**URL:** <https://discuss.ocaml.org/t/images-in-documentation/11125>\
**Category:** Learning\
**Created:** [January 6, 2023, 12:35pm UTC](https://discuss.ocaml.org/t/images-in-documentation/11125 "2023-01-06T12:35:56Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![sanette](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/sanette/32/1645_2.png) [@sanette](https://discuss.ocaml.org/u/sanette)\
**Post date:** [January 6, 2023, 12:35pm UTC](https://discuss.ocaml.org/t/images-in-documentation/11125/1 "2023-01-06T12:35:56Z")

</div>

Hi,

I like to put images when documenting my libraries, eg. [oplot](https://sanette.github.io/oplot/oplot/Oplot/index.html)  
However they are not included in the [ocaml.org](http://ocaml.org) documentation: [Oplot · oplot 0.50 · OCaml Packages](https://ocaml.org/p/oplot/0.50/doc/Oplot/index.html)

For the doc that I maintain on the github page, I have to upload the image files manually. However I cannot do this for [ocaml.org](http://ocaml.org). So, is there a way to have `odoc` (or `dune` ?) aware that some image files should be placed in the doc folder?

---

<div class="post-metadata">

**Author:** ![dbuenzli](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/dbuenzli/32/18_2.png) [@dbuenzli](https://discuss.ocaml.org/u/dbuenzli)\
**Post date:** [January 6, 2023, 12:57pm UTC](https://discuss.ocaml.org/t/images-in-documentation/11125/2 "2023-01-06T12:57:26Z")

</div>

No, see [this `odoc` issue](https://github.com/ocaml/odoc/issues/59). If you want them to show up in `odig` [here](https://erratique.ch/software/odig/doc/packaging.html#odoc_api_and_manual) is how.

(Some people suggested to work around using data URIs, but I’m not very fond of littering my sources with megabytes of base64 encoded binary data)

---

<div class="post-metadata">

**Author:** ![sanette](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/sanette/32/1645_2.png) [@sanette](https://discuss.ocaml.org/u/sanette)\
**Post date:** [January 6, 2023, 4:26pm UTC](https://discuss.ocaml.org/t/images-in-documentation/11125/3 "2023-01-06T16:26:57Z")

</div>

Thanks for the (sad) answer!  
Given that the issue is already quite old, I may use the (bad) temporary solution to include URLs to the images hosted on github.

But that’s bad because the images will not be available without internet connection, in a locally installed doc.

---

<div class="post-metadata">

**Author:** ![nobrowser](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/nobrowser/32/2099_2.png) [@nobrowser](https://discuss.ocaml.org/u/nobrowser)\
**Post date:** [January 6, 2023, 11:31pm UTC](https://discuss.ocaml.org/t/images-in-documentation/11125/4 "2023-01-06T23:31:50Z")

</div>

First of all, _animated_ images are pure evil. They trigger anxiety, so are an accessibility barrier. Please be aware of this. (This is actually one of the reasons I’ll never be able to use VSCode, because their documentation is full of these).

_Still_ images are okay this way, but are yet problematic if they require significant bandwidth to view. People are on limited metered connections.

–  
Ian

---

<div class="post-metadata">

**Author:** ![sanette](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/sanette/32/1645_2.png) [@sanette](https://discuss.ocaml.org/u/sanette)\
**Post date:** [January 7, 2023, 11:48am UTC](https://discuss.ocaml.org/t/images-in-documentation/11125/5 "2023-01-07T11:48:22Z")

</div>

did you try blocking animated images (or all images) in your browser setting?