If you ever wanted a plugin that displays an icon in case you have documentation on your node, the time has come. We proudly announce doc-red . It also gives you a sidebar where all todos are listed and has some nice features like auto-documentation of outputs. Please enjoy and let us know whether …

As per the other thread, would be great if you could update to target node.js versions of 18+ rather than specific versions which currently exclude v20 which I'm running and so I can't use the node I'm afraid.

As in the other thread mentioned we cannot reproduce that problem. We use node v20.18.0 and exclude only lower than v14. "engines": { "node": ">=14.0" } doc-red has also no dependencies (1 dev dependency). We installed it via cli and via node-red manager on a fresh system in gitpod and on a …

OK, thanks, probably my dev setup then which doubtless needs some tidying up!

Recently found this and like it. Any particular reason this is not available for groups? I understand they don't have input/outputs, but the #todo and signal of the presence of documentation would be nice.

Hi Jow, glad to hear, that there are more users finding this plugin useful. I'm just not sure if I get your point. You can add Todos and Docs like in nodes, groups and even tabs. [image] The current version is 1.6.0, please check if you use for some reasons an older version. Otherwise please o…

My bad. I assumed it didn't work because I didn't see the faint document icon in the left hand upper corner when you hover a group's edge when there's no documentation present. It does work, except for the hover. Thanks.

No problem. The hovered doc icon should also exist. It may is a bit difficult to find. If I find the time I will change that the icon will also be shown if the group is hovered. Then it has the same behaviour like nodes and tabs. [image]

Ha, I never even noticed the option for the "dummy" icon on hover. I've just turned it on and it is very useful! Many thanks for this contribution.

I can't however get the comments on every output of let's say a switch node to display. In the example comments of output 2 and 4 are skipped for some reason. [ { "id": "33a14c537ed9f895", "type": "switch", "z": "fa65a577079c6019", "name": "MySwitch", "pr…

Node-RED

Node-RED Forum

[ANNOUNCE] doc-red

Share Your Nodes

2WeltenChris 13 November 2024 15:52 3

More details on this plugin and some screenshots can be found in this thread.

Topic		Replies	Views
Special indication on nodes with description Feature Requests feature-request	139	2218	20 November 2025
Info icon for nodes with description? Feature Requests	8	168	18 March 2025
:tada: Node-RED 4.1.0.beta-1 now available News docker	22	1224	12 June 2025
Ways to improve flow documentation Feature Requests	28	541	18 December 2025
Improved node documentation icon General	8	149	4 August 2025

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

[ANNOUNCE] doc-red

Related topics