@redpanda-data/docs-extensions-and-macros/tools/redpanda-connect/helpers/renderConnectExamples.js

Antora extensions and macros developed for Redpanda documentation.

const handlebars = require('handlebars');

/**
 * Renders a list of examples.
 *
 * @param {Array<Object>} examples - An array of example objects.
 * @returns {handlebars.SafeString} The rendered SafeString containing the examples.
 */
module.exports = function renderConnectExamples(examples) {
  if (!examples || !Array.isArray(examples) || examples.length === 0) {
    return '';
  }
  let output = '';
  examples.forEach(example => {
    if (example.title) {
      const sanitizedTitle = example.title.replace(/[=]/g, '\\=');
      output += `=== ${sanitizedTitle}\n\n`;
    }
    if (example.summary) {
      output += `${example.summary}\n\n`;
    }
    if (example.config) {
      if (typeof example.config !== 'string') {
        console.warn('Example config must be a string, skipping');
        return;
      }
      const configContent = example.config.trim();
      if (configContent.includes('----')) {
        console.warn('Example config contains AsciiDoc delimiters, this may break rendering');
      }
      output += '[source,yaml]\n----\n';
      output += configContent + '\n';
      output += '----\n\n';
    }
  });
  return new handlebars.SafeString(output);
}