node-red-contrib-markdown-note 1.0.8

A Node-RED node for adding rich Markdown notes and annotations to your flows.

npm install node-red-contrib-markdown-note

Node-RED Markdown Note

A Node-RED node for adding Markdown-formatted notes directly on the flow canvas.
Designed for inline documentation, design notes, and contextual explanations that remain visible while editing or reviewing flows.

Why use Markdown Note?

The standard Comment node hides content by default. Markdown Note keeps your notes always visible, making it easier to:

• Document flow logic inline
• Highlight important information
• Include structured content with headings, lists, and code blocks

Features

• Always-visible notes – No need to click to expand.
• Markdown rendering – Support for headers, lists, emphasis, code blocks, quotes.
• Task lists – Track TODOs or action items inline.
• Resizable & readable layout – Automatically adjusts to content size.
• Developer-focused – Document payload formats, API contracts, assumptions, or edge cases directly on the flow.

Known Issues

• Links are not clickable: Due to Node-RED's security restrictions on SVG content in the flow editor, hyperlinks rendered in the markdown cannot be clicked.
• Visual jump on edit: When closing the edit dialog, the node may appear slightly displaced or "jump" until you click away (deselect the node). This is a rendering artifact of the flow editor's redraw cycle.

Installation

Using the Palette Manager (recommended)

1. Open Node-RED in your browser
2. Go to Menu → Manage palette → Install
3. Search for node-red-contrib-markdown-note
4. Click Install

Using npm

Run this in your Node-RED user directory (~/.node-red):

npm install node-red-contrib-markdown-note

Then restart Node-RED.

Support the Project

Markdown Note is free and open source.
If it has helped you or saved you time, consider supporting continued development:

GitHub Sponsors