Notes Component
Document a pipeline with Markdown and optionally include connected data in previews and exports.
Last updated:
The Notes Component reuses the workspace Notes Panel: the same Markdown editor, formatting toolbar, templates, live preview and .md download.
Write pipeline notes
- Drag Notes from the Views group onto the canvas.
- Double-click the node or choose Edit notes to open the editor.
- Write Markdown and use Preview to see the rendered document.
- Save or share the pipeline to retain each node's notes with its configuration.
Notes work without any connection. You can add several independent Notes nodes to document different parts of a workflow. Pipeline notes are independent of workspace notes.
Optional connected data
Connect one upstream node to Notes and enable Include connected data in preview and Markdown export to append its latest available data as a formatted JSON code block. The option is off by default and only enabled while the node has an incoming connection.
The generated Connected data section appears in Preview, copied Markdown and the .md download. It never replaces or becomes part of your editable text. Run the pipeline after changing upstream nodes to refresh the data; a directly connected JSON/NDJSON source can also be previewed before the first run.
For large datasets, connect a Limit or Group By node first to document a sample or summary.
Execution and persistence
Notes accept at most one incoming connection and pass connected data through unchanged. You can place Notes between processing nodes or on a separate branch. Markdown is exported from the notes editor; downstream pipeline nodes receive the original input data.
Only the authored Markdown and the inclusion setting are stored in the pipeline configuration. Generated data is reconstructed from the connected node when you reopen or run the workflow. With no input, Notes execute successfully without emitting data.