Keep rich, always-visible documentation directly on your Node-RED flow canvas.
Install · Try the example · Report a problem · Contribute
Markdown Note renders headings, lists, task lists, code, quotes, and custom colors without making reviewers open each node to read its contents.
The standard Comment node hides content by default. Markdown Note keeps your notes visible while you build or review a flow.
| Feature | Comment node | Markdown Note |
|---|---|---|
| Visibility | Collapsed by default | Always visible |
| Formatting | Plain text | Markdown headings, lists, code, and quotes |
| Colors | Fixed editor style | Custom background and text colors |
| Best suited for | Short comments | Structured inline documentation |
- Always-visible notes keep important context on the canvas.
- Markdown rendering supports headings, lists, emphasis, code, quotes, and task lists.
- Custom colors distinguish warnings, decisions, examples, or sections.
- Content-aware layout adjusts the node to its rendered content.
- Developer-focused documentation records payload formats, API contracts, assumptions, and edge cases beside the flow they describe.
Markdown Note requires Node-RED 3.0 or later.
In Node-RED, open Menu → Manage palette → Install, search for
node-red-contrib-markdown-note, and select Install. Restart Node-RED when
prompted.
To install from the Node-RED user directory instead:
npm install node-red-contrib-markdown-noteAfter restarting Node-RED, open Menu → Import → Examples → node-red-contrib-markdown-note to load the included example.
Import the example after restarting. Otherwise Node-RED reports
Imported unrecognized type: noteand cannot render the nodes.
Links render as text but are not clickable because of Node-RED editor restrictions on SVG content.
Bug reports, feature ideas, and pull requests are welcome. Use GitHub Issues to describe the problem or proposed behavior before starting a substantial change.
Markdown Note is free and open source. If it helps you document your flows, starring the repository helps other Node-RED users find it. Sponsorships are appreciated, but never expected.
