# More ways to provide help for your custom node

**URL:** <https://discourse.nodered.org/t/more-ways-to-provide-help-for-your-custom-node/41127>\
**Category:** Developing Nodes\
**Created:** [17 February 2021 00:03 UTC](https://discourse.nodered.org/t/more-ways-to-provide-help-for-your-custom-node/41127 "2021-02-17T00:03:27Z")\
**Posts on this page:** 2\
**Page:** 1

<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:** [17 February 2021 00:03 UTC](https://discourse.nodered.org/t/more-ways-to-provide-help-for-your-custom-node/41127/1 "2021-02-17T00:03:27Z")

</div>

Just wanted to share a quick tip for people writing custom nodes, especially if the are getting a bit more complex and needing more help space than is convenient in the Node-RED info panel.

uibuilder is now getting quite complex in places and I've been trying to add more help. In various bits of experimentation, I came across [docsify](https://docsify.js.org/#/).

This is a library that automatically takes a folder of Markdown files and creates a website out of them. It all happens in the browser so you only need a static web server - Node-RED happens to be quite good at that!

If you check out the [node-red-contrib-uibuilder](https://github.com/TotallyInformation/node-red-contrib-uibuilder) repository, you will see that it contains a `docs` folder with an [index.html](https://github.com/TotallyInformation/node-red-contrib-uibuilder/blob/main/docs/index.html) file. It is that file that does the magic.

In the uibuilder node, I simply attach the folder to Node-RED's admin ExpressJS server:

> <https://github.com/TotallyInformation/node-red-contrib-uibuilder/blob/main/nodes/uibuilder.js#L1648-L1651>

Then I add a link such as this to my help panel: `<a href="./uibuilder/techdocs" target="_blank">`.

---

<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:** [18 April 2021 00:04 UTC](https://discourse.nodered.org/t/more-ways-to-provide-help-for-your-custom-node/41127/2 "2021-04-18T00:04:06Z")

</div>

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