@redpanda-data/docs-extensions-and-macros/tools/docusaurus-to-antora-conversion-scripts/pre-process-markdown.js

Antora extensions and macros developed for Redpanda documentation.

const fs = require('fs');
const { execSync } = require('child_process');
const pandoc = require('node-pandoc');
// Fail fast if required CLIs are missing
['pandoc', 'kramdoc'].forEach(cmd => {
  try {
    execSync(`command -v ${cmd}`, { stdio: 'ignore' });
  } catch {
    console.error(`Required dependency "${cmd}" not found in PATH`);
    process.exit(1);
  }
});
const os = require('os');
const path = require('path');

function convertHtmlTableToAsciiDoc(htmlTable) {
  return new Promise((resolve, reject) => {
    pandoc(htmlTable, '-f html -t asciidoc', (err, result) => {
      if (err) {
        console.error(`Error converting HTML table to AsciiDoc: ${err.message}`);
        resolve(htmlTable);
      } else {
        resolve(result);
      }
    });
  });
}

function markdownToAsciidoc(markdown) {
  const tempMarkdownPath = path.join(os.tmpdir(), 'temp_markdown.md');
  fs.writeFileSync(tempMarkdownPath, markdown, 'utf-8');

  let result;
  try {
    const command = `kramdoc -o - "${tempMarkdownPath}"`;
    result = execSync(command, { encoding: 'utf-8' });
  } catch (err) {
    console.error(`Error converting Markdown to AsciiDoc: ${err.message}`);
    result = markdown;
  } finally {
    fs.unlinkSync(tempMarkdownPath);
  }
  return result;
}

function processTabs(match) {
  const tabItems = [...match.matchAll(/\s?<TabItem[^>]*value="([^"]+)"[^>]*label="([^"]+)"[^>]*>([\s\S]*?)<\/TabItem>/g)];

  let result = ['\n<!--\n[tabs]'];
  result.push('=====');
  for (const tabItem of tabItems) {
    const [_, value, label, content] = tabItem;
    result.push(`${label}::`);
    result.push('+');
    result.push('--');
    const asciidocContent = markdownToAsciidoc(content.trim(), '');
    result.push(asciidocContent);
    result.push('--');
  }

  result.push('=====');
  result.push('-->');
  return result.join('\n');
}

function processDetails(match) {
  const detailsRegex = /<details>(?:\r?\n)<summary>([\s\S]*?)<\/summary>(?:\r?\n)([\s\S]*?)(?:\r?\n)<\/details>/g;

  return match.replace(detailsRegex, (match, title, content) => {
    const asciidocTitle = `.${title.trim()}`;
    const asciidocBlock = `[%collapsible%]\n====\n${content.trim()}\n====`;

    return `<!--\n${asciidocTitle}\n${asciidocBlock}\n-->`;
  });
}

async function convertFile(file) {
  const content = fs.readFileSync(file, 'utf-8');

  var newContent = content.replace(/<Tabs>([\s\S]*?)<\/Tabs>/g, processTabs);
  newContent = newContent.replace(/<details>([\s\S]*?)<\/details>/g, processDetails);

  const htmlTableMatches = newContent.match(/\s?(<table>((.|\n)*?)<\/table>)/g);
  if (htmlTableMatches) {
    for (const htmlTableMatch of htmlTableMatches) {
      const tableRegex = /(<table>((.|\n)*?)<\/table>)/;
      const tableMatch = htmlTableMatch.match(tableRegex);
      if (tableMatch) {
        const htmlTable = tableMatch[0];
        const asciidocTable = await convertHtmlTableToAsciiDoc(htmlTable);
        newContent = newContent.replace(htmlTableMatch, `\n<!--\n${asciidocTable}\n-->`);
      }
    }
  }

  fs.writeFileSync(file, newContent, 'utf-8');
}

const inputFile = process.argv[2];
if (!inputFile) {
  console.error('No input file provided');
  process.exit(1);
}

convertFile(inputFile).catch((error) => {
  console.error(`Error processing file: ${error.message}`);
  process.exit(1);
});