extractCommentary method

Implementation

String extractCommentary(String title) {
  bool foundTitle = false;
  List<String> result = [];
  List<String> lines = title.split('\n');

  // Use a regular expression to check if the string starts with spaces
  // followed by a #.

  RegExp regExp = RegExp(r'^\s*#(.*)');

  for (String line in lines) {
    // Check if the string is the first non-empty line that starts with
    // optional space followed by #.

    if (!foundTitle) {
      if (regExp.hasMatch(line)) {
        foundTitle = true;
        continue;
      }
    } else {
      result.add(line);
    }
  }

  // Replace matches of [XXXX](YYYY) with the desired format.

  String fin = result.join().trim().replaceAll(RegExp(r'\s+'), ' ');
  regExp = RegExp(r'\[([^\]]+)\]\(([^)]+)\)');
  fin = fin.replaceAllMapped(regExp, (Match match) {
    String text = match.group(1)!; // XXXXX
    // String link = match.group(2)!; // YYYY

    return text;
  });

  return fin;
}