Skip to content

Backroads4Me/node-red-contrib-markdown-note

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node-RED Markdown Note

NPM Version Downloads License

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.

Node Preview


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
Feature Comment Node Markdown Note
Visibility Collapsed by default Always visible
Formatting Plain text Markdown (headers, lists, code, blockquotes)
Colors Fixed editor style Custom background and text colors
Structure Minimal Suitable for detailed documentation

Features

  • Always-visible notes – No need to click to expand.
  • Markdown rendering – Support for headers, lists, emphasis, code blocks, quotes.
  • Custom colors – Choose the note background and text color from the node properties.
  • 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.

Limitations

  • Links are rendered as text but are not clickable due to Node-RED editor restrictions on SVG content.

Installation

Using the Palette Manager (recommended)

  1. Open Node-RED in your browser
  2. Go to MenuManage paletteInstall
  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

Markdown Note is free and open source.

If it helped you document your flows, please star the repository so other Node-RED users can find it.

Sponsorships are appreciated, but never expected.

Star Repository GitHub Sponsors

About

A Node-RED node for adding Markdown-formatted notes

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors