# Including images when documenting nodes

**URL:** <https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010>\
**Category:** General\
**Created:** [8 April 2022 21:08 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010 "2022-04-08T21:08:56Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![dgilleland](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/dgilleland/32/59817_2.png) [@dgilleland](https://discourse.nodered.org/u/dgilleland)\
**Post date:** [8 April 2022 21:08 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/1 "2022-04-08T21:08:56Z")

</div>

I'm creating documentation for nodes in my flow, and I want to include images that can show up in the info tab.

Is this possible, and how would I do it?

The following sample shows my attempt, but the image is not rendering.

 ![image](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/a/a/aa6c9d8efad2f97394c1296862f8a42ae041512d.png)

---

<div class="post-metadata">

**Author:** ![TotallyInformation](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/totallyinformation/32/31_2.png) [@TotallyInformation](https://discourse.nodered.org/u/TotallyInformation)\
**Post date:** [8 April 2022 21:47 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/2 "2022-04-08T21:47:30Z")

</div>

Check through the recent release notes because something was released not long back that allows a custom node to use a folder that will be attached to the Editor's web server. Sorry but I can't remember the details.

---

<div class="post-metadata">

**Author:** ![dgilleland](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/dgilleland/32/59817_2.png) [@dgilleland](https://discourse.nodered.org/u/dgilleland)\
**Post date:** [8 April 2022 22:13 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/3 "2022-04-08T22:13:02Z")

</div>

Thanks. I know that if you _import_ a node or flow with a "resources" folder, then you can reference the image in that folder because it's part of the palette (which is great for documenting your published nodes/flows for others to use).

But my question is more about _documenting a node in the **workspace editor** _, not a node in the palette. I tried to see if it would work the same as an imported node (I'm using Projects, by the way) by using a "resources" folder in the git project, but that doesn't get imported into the Node-RED server.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [8 April 2022 22:20 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/4 "2022-04-08T22:20:59Z")

</div>

Short answer is there isn't a way, as a flow author, to include images in the descriptions of nodes/flows - unless they are hosted externally outside of Node-RED.

---

<div class="post-metadata">

**Author:** ![dgilleland](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/dgilleland/32/59817_2.png) [@dgilleland](https://discourse.nodered.org/u/dgilleland)\
**Post date:** [8 April 2022 22:29 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/5 "2022-04-08T22:29:03Z")

</div>

Ok. Thanks for the reply!

BTW, I've just discovered Node-RED. I must say that I'm highly impressed!

I've been tasked with curriculum development on a proposed IoT course (post-secondary). Our program is focused more on programming rather than hardware, so I'm taking the approach of simulating hardware with TinkerCAD and then Node-RED. I'm going this route in part because it's so hard to get Raspberry PI boards these days.

Anyway, I was asking the question because I'm building up a bunch of simple demos in Node-RED and am documenting the flows/nodes.

Thanks again!

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)\
**Post date:** [7 June 2022 22:29 UTC](https://discourse.nodered.org/t/including-images-when-documenting-nodes/61010/6 "2022-06-07T22:29:21Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.