Skip to content

Commit

Permalink
Revert "Add meta information to core-node docs"
Browse files Browse the repository at this point in the history
  • Loading branch information
@ZJvandeWeg
ZJvandeWeg authored Jun 15, 2024
1 parent 749df69 commit 1a5c98c
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 155 deletions.
197 changes: 46 additions & 151 deletions src/_data/coreNodes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,298 +4,193 @@
"xpath": "inject",
"name": "Inject",
"file": "20-inject",
"description": "Explore the Node-RED Inject node to learn its usage, understand versatile applications, and discover practical examples.",
"keywords": "node-red inject node, repeat messages, specific time, inject node use case, inject node example flow"
"description": "Guide on the Node-RED core node that injects a message into a flow",
"keywords": "inject, message, flow"
},
{
"xpath": "debug",
"name": "Debug",
"file": "21-debug",
"description": "Learn how to effectively use the Node-RED Debug node for debugging: configure output options, gain insights into flow data, and explore practical examples",
"keywords": "node-red debug node, debugging, printing messages to debug sidebar, debug node use case, debug node example flow"
"file": "21-debug"
},
{
"xpath": "complete",
"name": "Complete",
"file": "24-complete",
"description": "Learn about the Node-RED Complete Node to trigger flows on task completion, handle async operations, and explore examples for streamlined automation.",
"keywords": "node-red complete node, asynchronous operations, complete node use case, complete node example flow"
"file": "24-complete"
},
{
"xpath": "catch",
"name": "Catch",
"file": "25-catch",
"description": "Learn how to use the Node-RED Catch node to manage errors, handle asynchronous operations, and explore real-world examples for effective error handling in your flows.",
"keywords": "node-red catch node, error handling, catch node use case, catch node example flow"
"file": "25-catch"
},
{
"xpath": "status",
"name": "Status",
"file": "25-status",
"description": "Explore the Node-RED Status node: monitor and react to node and flow statuses in real-time with practical examples.",
"keywords": "node-red status node, monitoring flow status, status node use case, status node example flow"
"file": "25-status"
},
{
"xpath": "link",
"name": "Link",
"file": "60-link",
"description": "Explore how to connect and exchange data between different flows in Node-RED using the Link In and Link Out nodes, enhancing flow organization and data handling.",
"keywords": "node-red link nodes, link in and link out nodes, exchange data between flows, link node use case, link node example flow"
"file": "60-link"
},
{
"xpath": "comment",
"name": "Comment",
"file": "90-comment",
"description": "Enhance flow readability, simplify debugging, and improve maintenance in Node-RED with the Comment node, using detailed inline comments and explanations.",
"keywords": "node-red comment nodes, flow documentation, inline comments, flow readability, comment node use case, comment node example flow"
"file": "90-comment"
},
{
"xpath": "unknown",
"name": "Unknown",
"file": "98-unknown",
"description": "Learn about the Node-RED 'unknown' node and how it is displayed when importing flows with nodes that have not been installed yet.",
"keywords": "node-red unknown node, showing unknown, node not installed, unknown node use case, unknown node example flow"
"file": "98-unknown"
}
],
"function": [
{
"xpath": "function",
"name": "Function",
"file": "10-function",
"description": "Learn to use the Node-RED Function node. Write JavaScript to process messages, handle tasks, and customize flows with practical examples.",
"keywords": "node-red function node, writing custom javascript, flow customization, function node use case, function node example flow"
"file": "10-function"
},
{
"xpath": "switch",
"name": "Switch",
"file": "10-switch",
"description": "Learn to use the Switch node in Node-RED for directing messages based on conditions, such as filtering, conditional routing, and event processing.",
"keywords": "node-red switch node, conditional routing, switch node use case, switch node example flow"
"file": "10-switch"
},
{
"xpath": "change",
"name": "Change",
"file": "15-change",
"description": "Discover how the Node-RED Change node simplifies data manipulation in flows with practical examples for filtering, enriching, renaming, and formatting messages.",
"keywords": "node-red change node, message transformation, data manipulation, message filtering, rename properties, message formatting, change node use case, change node example flow"
"file": "15-change"
},
{
"xpath": "range",
"name": "Range",
"file": "16-range",
"description": "Learn how the Node-RED Range node scales, normalizes, and converts numeric values across different ranges, with practical examples.",
"keywords": "node-red range node, numeric value mapping, data scaling, analog-to-digital conversion, range node use case, range node example flow"
"file": "16-range"
},
{
"xpath": "template",
"name": "Template",
"file": "80-template",
"description": "Learn to use the Node-RED Template node to create dynamic text templates with Mustache syntax, populate data, configure output formats, and generate HTML or JSON.",
"keywords": "node-red template node, mustache template, html template, text template, dynamic content, template node use case, template node example flow"
"file": "80-template"
},
{
"xpath": "delay",
"name": "Delay",
"file": "89-delay",
"description": "Learn How to use the Node-RED Delay node to control message timing, rate limit requests, ensure order, and simulate real-world conditions.",
"keywords": "node-red delay node, message timing control, rate limiting, message batching, sequential message processing, delay node use case, delay node example flow"
"file": "89-delay"
},
{
"xpath": "trigger",
"name": "Trigger",
"file": "89-trigger",
"description": "Learn how to use the Trigger node in Node-RED to initiate and repeat messages at precise intervals, automate tasks, manage timeouts, and conserve resources efficiently.",
"keywords": "node-red trigger node, message scheduling, message recurrence, message triggering, trigger node use case, trigger node example flow"
"file": "89-trigger"
},
{
"xpath": "exec",
"name": "Exec",
"file": "90-exec",
"description": "Learn to use the exec node in Node-RED for executing command-line commands and managing output. Explore its features, limitations, and why it's disabled on FlowFuse Cloud.",
"keywords": "node-red exec node, command line, node-red exec node output, node-red exec node disabled, exec node use case, exec node example flow"
"file": "90-exec"
},
{
"xpath": "rbe",
"name": "Filter",
"file": "rbe",
"description": "Learn to use the Node-RED Filter node for efficient data transmission. Explore deadband and narrowband modes to filter changes and values with practical examples.",
"keywords": "node-red, filter node, deadband mode, narrowband mode, report by exception, rbe node, optimize data transmission, rbe node use case, rbe node example flow"
"file": "rbe"
}
],
"network": [
{
"xpath": "tls",
"name": "TLS",
"file": "05-tls",
"description": "Learn to configure TLS in Node-RED using the TLS Config node for secure, encrypted communication with HTTP, TCP, and custom network nodes.",
"keywords": "tls config node, node-red tls configuration, secure communication, encrypted communication, tls node use case, tls node example flow"
"file": "05-tls"
},
{
"xpath": "http proxy",
"name": "HTTP Proxy",
"file": "06-httpproxy",
"description": "Learn how to set up an http proxy in node-red to route outgoing requests through a proxy server.",
"keywords": "node-red http proxy, proxy configuration, routing http requests, http proxy server, http proxy node use case, http proxy node example flow"
"file": "06-httpproxy"
},
{
"xpath": "mqtt broker",
"name": "MQTT broker",
"file": "06-httpbroker",
"description": "Learn how to configure MQTT broker settings in Node-RED using the MQTT Broker Config node for MQTT In and Out nodes.",
"keywords": "node-red http proxy, proxy configuration, routing http requests, http proxy server, mqtt broker node use case, mqtt broker node example flow"
},
{
"xpath": "mqtt in",
"name": "MQTT in",
"file": "10-mqttin",
"description": "Learn to configure and use MQTT-in nodes in Node-RED for subscribing to MQTT broker topic patterns. Explore practical examples and setup guides for efficient message handling.",
"keywords": "node-red mqtt-in node, node-red mqtt, subscribing to mqtt topic, mqtt message handling, data streaming, mqtt in node use case, mqtt in node example flow"
},
{
"xpath": "mqtt out",
"name": "MQTT out",
"file": "10-mqttout",
"description": "Learn how to use MQTT out nodes in Node-RED for publishing messages over an MQTT broker. Explore practical examples and setup guides for efficient communication.",
"keywords": "node-red mqtt-out node, node-red mqtt, publishing messages, data streaming, mqtt out usecase, mqtt out example flow"
"xpath": "mqtt",
"name": "MQTT",
"file": "10-mqtt"
},
{
"xpath": "http in",
"name": "HTTP in",
"file": "21-httpin",
"description": "Learn how to use HTTP In nodes in Node-RED: Create HTTP endpoints, trigger flows with GET, POST, PUT, and DELETE methods, and send different types of data as responses.",
"keywords": "node-red http-in node, http server, get request, creating api, http in usecase, http in example flow"
"file": "21-httpin"
},
{
"xpath": "http request",
"name": "HTTP request",
"file": "21-httprequest",
"description": "Learn to use HTTP Request nodes in Node-RED for making various HTTP requests (GET, POST, PUT, DELETE, PATCH), managing JSON data, and integrating with APIs efficiently.",
"keywords": "node-red http-request node, handle http requests, get request, post request, put request, delete request, patch request, http request usecase, http request example flow"
},
{
"xpath": "http response",
"name": "HTTP response",
"file": "21-httpresponse",
"description": "Learn to use the HTTP Response node in Node-RED to send customized HTTP responses, set status codes, headers, and manage cookies for dynamic client interaction.",
"keywords": "node-red http response node, setting cookies, sending response back, status codes, http response usecase, http response example flow"
"file": "21-httprequest"
},
{
"xpath": "websocket",
"name": "WebSocket",
"file": "22-websocket",
"description": "Learn how to use the WebSocket node in Node-RED to enable bidirectional communication between clients and servers over a single, long-lived connection.",
"keywords": "node-red websocket node, websocket communication, bidirectional communication, real-time data exchange, websocket usecase, websocket example flow"
"file": "22-websocket"
},
{
"xpath": "tcp in",
"name": "TCP in",
"file": "31-tcpin",
"description": "Learn to use Node-RED's TCP nodes for TCP/IP communication. Configure client and server modes, integrate IoT devices, and streamline workflows.",
"keywords": "node-red tcp-in nodes, tcp/ip communication, tcp client, tcp servers, tcp in usecase, tcp in example flow"
},
{
"xpath": "tcp out",
"name": "TCP out",
"file": "32-tcpout",
"description": "Learn how to utilize TCP-Out nodes in Node-RED for efficient TCP/IP communication. Connect to remote ports, reply to messages, and ensure secure data transmission.",
"keywords": "node-red tcp-out node, tcp communication, tcp client, tcp servers, tcp out usecase, tcp out example flow"
},
{
"xpath": "upd in",
"name": "UDP in",
"file": "33-udpin",
"description": "Learn how to use the UDP-In node in Node-RED for receiving UDP messages from remote devices or services.",
"keywords": "node-red udp-in node, receive udp messages, real-time data reception, udp in usecase, udp in example flow"
"file": "31-tcpin"
},
{
"xpath": "upd out",
"name": "UDP out",
"file": "33-udpout",
"description": "Learn how to send UDP messages using the udp-out node in Node-RED for real-time data transmission",
"keywords": "node-red udp-out node, real-time data transmission, udp out usecase, udp out example flow"
"xpath": "upd",
"name": "UDP",
"file": "32-udp"
}
],
"parsers": [
{
"xpath": "csv",
"name": "CSV",
"file": "70-csv",
"description": "Learn how to process CSV data in Node-RED using the CSV node. Convert CSV strings to JavaScript objects or vice versa",
"keywords": "node-red csv node, convert csv to json, parse csv, tabular data handling, csv usecase, csv example flow"
"file": "70-CSV"
},
{
"xpath": "html",
"name": "HTML",
"file": "70-html",
"description": "Learn how to parse HTML content using the HTML node in Node-RED. Extract specific HTML elements like h1 tags from web pages.",
"keywords": "node-red html node, parse html, html parsing, html parsing example, html usecase, html example flow"
"file": "70-HTML"
},
{
"xpath": "json",
"name": "JSON",
"file": "70-json",
"description": "Learn how to use the JSON node in Node-RED for manipulating data between JSON format and JavaScript objects, essential for API interactions and data storage.",
"keywords": "node-red json node, json manipulation, json to object, object to json, json formatting, json usecase, json example flow"
"file": "70-JSON"
},
{
"xpath": "xml",
"name": "XML",
"file": "70-xml",
"description": "Learn how to use the XML node in Node-RED for parsing XML data to JSON and converting JSON to XML.",
"keywords": "node-red xml node, parse xml to json, convert json to xml, xml usecase, xml example flow"
"file": "70-XML"
},
{
"xpath": "yaml",
"name": "YAML",
"file": "70-yaml",
"description": "Learn how to use the YAML node in Node-RED for parsing and generating YAML data. Convert YAML to JSON and vice versa.",
"keywords": "node-red yaml node, yaml to json, json to yaml, yaml file handling, yaml usecase, yaml example flow"
"file": "70-YAML"
}
],
"sequence": [
{
"xpath": "split",
"name": "Split",
"file": "17-split",
"description": "Learn to use the Split node in Node-RED to divide messages based on rules. Split strings, arrays, and objects to handle data effectively in workflows.",
"keywords": "node-red split node, divide messages, split strings, split arrays, split objects, message splitting, message processing, split usecase, split example flow"
"file": "17-split"
},
{
"xpath": "sort",
"name": "Sort",
"file": "18-sort",
"description": "Learn how to use the Sort node in Node-RED to organize data efficiently. Sort messages or sequences in ascending or descending order for better processing.",
"keywords": "node-red sort node, message sorting, data processing, message sequences, ascending order, descending order, sort usecase, sort example flow"
"file": "18-sort"
},
{
"xpath": "batch",
"name": "Batch",
"file": "19-batch",
"description": "Learn how to use the Batch node in Node-RED to group sequences of messages into batches based on number or time interval.",
"keywords": "node-red batch node, batch processing, data processing, batch usecase, batch example flow"
"file": "19-batch"
},
{
"xpath": "join",
"name": "Join",
"file": "17-join",
"description": "Learn how to use the Join node in Node-RED for merging multiple messages into one. Explore its practical examples and use cases for data aggregation and processing.",
"keywords": "node-red join node, data aggregation, message processing, join usecase, join example flow"
"file": "17-split"
}
],
"storage": [
{
"xpath": "file write",
"name": "File write",
"file": "10-filewrite",
"description": "Learn how to use the Write File Node in Node-RED for efficient data logging and management. ",
"keywords": "node-red write file node, data logging, writing data to file, deleting file, file write usecase, file write example flow"
"xpath": "file",
"name": "File",
"file": "10-file"
},
{
"xpath": "file read",
"name": "File read",
"file": "23-fileread",
"description": "Learn how to use the read file node in node-red to read file contents from the file system.",
"keywords": "node-red mqtt config node, configuring mqtt nodes, file read usecase, file read example flow"
"xpath": "watch",
"name": "Watch",
"file": "23-watch"
}
]
}
}
0 ...includes/core-nodes/file-read-use-case.md → ...includes/core-nodes/read-file-use-case.md
View file
File renamed without changes.
4 changes: 0 additions & 4 deletions src/node-red/core-nodes/index.njk
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
eleventyNavigation:
key: Core Nodes
meta:
title: Node-RED Core Nodes
description: Learn about the Node-RED core nodes, how to use them for building application with Node-RED. Explore diffrent usecases and practicle examples.
keywords: node-red core nodes
---
<h1>Node-RED Core Nodes</h1>

Expand Down

0 comments on commit 1a5c98c

Please sign in to comment.