Add markdown renderers and renderer factory

lib/src/model/package_builder.dart

@@ -42,8 +42,8 @@ class PackageBuilder {
     if (config.topLevelPackageMeta.needsPubGet) {
       config.topLevelPackageMeta.runPubGet();
     }
-    // TODO(jdkoren): change factory for other formats based on config options
-    RendererFactory rendererFactory = HtmlRenderFactory();
+
+    RendererFactory rendererFactory = RendererFactory.forFormat(config.format);
 
     PackageGraph newGraph = PackageGraph.UninitializedPackageGraph(
         config, driver, sdk, hasEmbedderSdkFiles, rendererFactory);

lib/src/render/category_renderer.dart

@@ -31,7 +31,7 @@ class CategoryRendererHtml extends CategoryRenderer {
 
     StringBuffer buf = StringBuffer();
     buf.write('<span class="${spanClasses.join(' ')}" title="$spanTitle">');
-    buf.write(category.linkedName);
+    buf.write(renderLinkedName(category));
     buf.write('</span>');
     return buf.toString();
   }
@@ -46,3 +46,17 @@ class CategoryRendererHtml extends CategoryRenderer {
     }
   }
 }
+
+class CategoryRendererMd extends CategoryRenderer {
+  @override
+  String renderCategoryLabel(Category category) => renderLinkedName(category);
+
+  @override
+  String renderLinkedName(Category category) {
+    String name = category.name;
+    if (category.isDocumented) {
+      return '[$name](${category.href})';
+    }
+    return name;
+  }
+}

lib/src/render/element_type_renderer.dart

@@ -11,6 +11,8 @@ abstract class ElementTypeRenderer<T extends ElementType> {
   String renderNameWithGenerics(T elementType) => '';
 }
 
+// Html implementations
+
 class FunctionTypeElementTypeRendererHtml
     extends ElementTypeRenderer<FunctionTypeElementType> {
   @override
@@ -93,3 +95,83 @@ class CallableElementTypeRendererHtml
     return buf.toString();
   }
 }
+
+// Markdown implementations
+
+class FunctionTypeElementTypeRendererMd
+    extends ElementTypeRenderer<FunctionTypeElementType> {
+  @override
+  String renderLinkedName(FunctionTypeElementType elementType) {
+    StringBuffer buf = StringBuffer();
+    buf.write('${elementType.returnType.linkedName} ');
+    buf.write('${elementType.nameWithGenerics}');
+    buf.write('(');
+    buf.write(ParameterRendererMd().renderLinkedParams(elementType.parameters));
+    buf.write(')');
+    return buf.toString();
+  }
+
+  @override
+  String renderNameWithGenerics(FunctionTypeElementType elementType) {
+    StringBuffer buf = StringBuffer();
+    buf.write(elementType.name);
+    if (elementType.typeFormals.isNotEmpty) {
+      if (!elementType.typeFormals.every((t) => t.name == 'dynamic')) {
+        buf.write('<');
+        buf.writeAll(elementType.typeFormals.map((t) => t.name), ', ');
+        buf.write('>');
+      }
+    }
+    return buf.toString();
+  }
+}
+
+class ParameterizedElementTypeRendererMd
+    extends ElementTypeRenderer<ParameterizedElementType> {
+  @override
+  String renderLinkedName(ParameterizedElementType elementType) {
+    StringBuffer buf = StringBuffer();
+    buf.write(elementType.element.linkedName);
+    if (elementType.typeArguments.isNotEmpty &&
+        !elementType.typeArguments.every((t) => t.name == 'dynamic')) {
+      buf.write('<');
+      buf.writeAll(elementType.typeArguments.map((t) => t.linkedName), ', ');
+      buf.write('>');
+    }
+    return buf.toString();
+  }
+
+  @override
+  String renderNameWithGenerics(ParameterizedElementType elementType) {
+    StringBuffer buf = StringBuffer();
+    buf.write(elementType.element.name);
+    if (elementType.typeArguments.isNotEmpty &&
+        !elementType.typeArguments.every((t) => t.name == 'dynamic')) {
+      buf.write('<');
+      buf.writeAll(
+          elementType.typeArguments.map((t) => t.nameWithGenerics), ', ');
+      buf.write('>');
+    }
+    return buf.toString();
+  }
+}
+
+class CallableElementTypeRendererMd
+    extends ElementTypeRenderer<CallableElementType> {
+  @override
+  String renderLinkedName(CallableElementType elementType) {
+    if (elementType.name != null && elementType.name.isNotEmpty) {
+      return elementType.superLinkedName;
+    }
+
+    StringBuffer buf = StringBuffer();
+    buf.write(elementType.nameWithGenerics);
+    buf.write('(');
+    buf.write(ParameterRendererMd()
+        .renderLinkedParams(elementType.element.parameters, showNames: false)
+        .trim());
+    buf.write(') → ');
+    buf.write(elementType.returnType.linkedName);
+    return buf.toString();
+  }
+}

lib/src/render/enum_field_renderer.dart

@@ -18,3 +18,14 @@ class EnumFieldRendererHtml extends EnumFieldRenderer {
     }
   }
 }
+
+class EnumFieldRendererMd extends EnumFieldRenderer {
+  @override
+  String renderValue(EnumField field) {
+    if (field.name == 'values') {
+      return 'const List<${field.enclosingElement.name}>';
+    } else {
+      return 'const ${field.enclosingElement.name}(${field.index})';
+    }
+  }
+}

lib/src/render/model_element_renderer.dart

@@ -95,3 +95,17 @@ class ModelElementRendererHtml extends ModelElementRenderer {
 '''; // Must end at start of line, or following inline text will be indented.
   }
 }
+
+class ModelElementRendererMd extends ModelElementRendererHtml {
+  @override
+  String renderLinkedName(ModelElement modelElement) {
+    if (modelElement.isDeprecated) {
+      return '[~~${modelElement.name}~~](${modelElement.href})';
+    }
+    return '[${modelElement.name}](${modelElement.href})';
+  }
+
+  @override
+  String renderExtendedDocLink(ModelElement modelElement) =>
+      '[...](${modelElement.href})';
+}

lib/src/render/parameter_renderer.dart

@@ -42,6 +42,35 @@ class ParameterRendererHtml extends ParameterRenderer {
   String required(String required) => '<span>$required</span>';
 }
 
+class ParameterRendererMd extends ParameterRenderer {
+  @override
+  String annotation(String annotation) => annotation;
+
+  @override
+  String covariant(String covariant) => covariant;
+
+  @override
+  String defaultValue(String defaultValue) => defaultValue;
+
+  @override
+  String listItem(String item) => item;
+
+  @override
+  String orderedList(String listItems) => listItems;
+
+  @override
+  String parameter(String parameter, String id) => parameter;
+
+  @override
+  String parameterName(String parameterName) => parameterName;
+
+  @override
+  String required(String required) => required;
+
+  @override
+  String typeName(String typeName) => typeName;
+}
+
 abstract class ParameterRenderer {
   String listItem(String item);
   String orderedList(String listItems);

lib/src/render/renderer_factory.dart

@@ -14,6 +14,17 @@ import 'package:dartdoc/src/render/type_parameters_renderer.dart';
 import 'package:dartdoc/src/render/typedef_renderer.dart';
 
 abstract class RendererFactory {
+  static RendererFactory forFormat(String format) {
+    switch (format) {
+      case 'html':
+        return HtmlRenderFactory();
+      case 'md':
+        return MdRenderFactory();
+      default:
+        throw ArgumentError('Unsupported format: $format');
+    }
+  }
+
   TemplateRenderer get templateRenderer;
 
   CategoryRenderer get categoryRenderer;
@@ -86,3 +97,50 @@ class HtmlRenderFactory extends RendererFactory {
   @override
   TypedefRenderer get typedefRenderer => TypedefRendererHtml();
 }
+
+class MdRenderFactory extends RendererFactory {
+  @override
+  TemplateRenderer get templateRenderer => MdTemplateRenderer();
+
+  @override
+  CategoryRenderer get categoryRenderer => CategoryRendererMd();
+
+  // We render documentation as HTML for now.
+  // TODO(jdkoren): explore using documentation directly in the output file.
+  @override
+  DocumentationRenderer get documentationRenderer =>
+      DocumentationRendererHtml();
+
+  @override
+  ElementTypeRenderer<CallableElementType> get callableElementTypeRenderer =>
+      CallableElementTypeRendererMd();
+
+  @override
+  ElementTypeRenderer<FunctionTypeElementType>
+      get functionTypeElementTypeRenderer =>
+          FunctionTypeElementTypeRendererMd();
+
+  @override
+  ElementTypeRenderer<ParameterizedElementType>
+      get parameterizedElementTypeRenderer =>
+          ParameterizedElementTypeRendererMd();
+
+  @override
+  EnumFieldRenderer get enumFieldRenderer => EnumFieldRendererMd();
+
+  @override
+  ModelElementRenderer get modelElementRenderer => ModelElementRendererMd();
+
+  @override
+  ParameterRenderer get parameterRenderer => ParameterRendererMd();
+
+  @override
+  ParameterRenderer get parameterRendererDetailed => parameterRenderer;
+
+  @override
+  TypeParametersRenderer get typeParametersRenderer =>
+      TypeParametersRendererMd();
+
+  @override
+  TypedefRenderer get typedefRenderer => TypedefRendererMd();
+}

lib/src/render/template_renderer.dart

@@ -16,3 +16,14 @@ class HtmlTemplateRenderer implements TemplateRenderer {
     }
   }
 }
+
+class MdTemplateRenderer implements TemplateRenderer {
+  @override
+  String composeLayoutTitle(String name, String kind, bool isDeprecated) {
+    if (isDeprecated) {
+      return '~~${name}~~ ${kind}';
+    } else {
+      return '${name} ${kind}';
+    }
+  }
+}

lib/src/render/type_parameters_renderer.dart

@@ -6,6 +6,7 @@ import 'package:dartdoc/src/model/type_parameter.dart';
 
 abstract class TypeParametersRenderer {
   String renderGenericParameters(TypeParameters typeParameters);
+
   String renderLinkedGenericParameters(TypeParameters typeParameters);
 }
 
@@ -32,3 +33,22 @@ class TypeParametersRendererHtml extends TypeParametersRenderer {
     return '<span class="signature">&lt;<wbr><span class="type-parameter">${joined}</span>&gt;</span>';
   }
 }
+
+class TypeParametersRendererMd extends TypeParametersRenderer {
+  @override
+  String renderGenericParameters(TypeParameters typeParameters) =>
+      _compose(typeParameters.typeParameters, (t) => t.name);
+
+  @override
+  String renderLinkedGenericParameters(TypeParameters typeParameters) =>
+      _compose(typeParameters.typeParameters, (t) => t.linkedName);
+
+  String _compose(List<TypeParameter> typeParameters,
+      String Function(TypeParameter) mapfn) {
+    if (typeParameters.isEmpty) {
+      return '';
+    }
+    var joined = typeParameters.map(mapfn).join(', ');
+    return '<${joined}>';
+  }
+}

lib/src/render/typedef_renderer.dart

@@ -20,3 +20,14 @@ class TypedefRendererHtml extends TypedefRenderer {
     return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
   }
 }
+
+class TypedefRendererMd extends TypedefRenderer {
+  @override
+  String renderGenericParameters(Typedef typedef) {
+    if (typedef.genericTypeParameters.isEmpty) {
+      return '';
+    }
+    var joined = typedef.genericTypeParameters.map((t) => t.name).join(', ');
+    return '<{$joined}>';
+  }
+}

lib/templates/md/_callable.md

@@ -1,3 +1,3 @@
-{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+{{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}} {{>categorization}}
 : {{{ oneLineDoc }}} {{{ extendedDocLink }}}
 {{>features}}

lib/templates/md/_class.md

@@ -1,2 +1,2 @@
-{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}
 : {{{ oneLineDoc }}} {{{ extendedDocLink }}}

lib/templates/md/_constant.md

@@ -1,3 +1,3 @@
-{{#isDeprecated}}~~{{/isDeprecated}}{{{ linkedName }}} const {{{ linkedReturnType }}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+{{{ linkedName }}} const {{{ linkedReturnType }}} {{>categorization}}
 : {{{ oneLineDoc }}} {{{ extendedDocLink }}}
 {{>features}}

lib/templates/md/_extension.md

@@ -1,2 +1,2 @@
-{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+{{{linkedName}}} {{>categorization}}
 : {{{ oneLineDoc }}} {{{ extendedDocLink }}}

lib/templates/md/_mixin.md

@@ -1,2 +1,2 @@
-{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}
 : {{{ oneLineDoc }}} {{{ extendedDocLink }}}

lib/templates/md/constructor.md

@@ -14,7 +14,7 @@
 {{/hasAnnotations}}
 
 {{#isConst}}const{{/isConst}}
-{{#isDeprecated}}~~{{/isDeprecated}}{{{nameWithGenerics}}}({{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}}){{#isDeprecated}}~~{{/isDeprecated}}
+{{{nameWithGenerics}}}({{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}})
 
 {{>documentation}}
 

test/model_test.dart

@@ -373,6 +373,7 @@ void main() {
           equals(utils.kTestPackagePublicLibraries - 5));
     });
 
+    // TODO consider moving these to a separate suite
     test('CategoryRendererHtml renders category label', () {
       Category category = packageGraph.publicPackages.first.categories.first;
       CategoryRendererHtml renderer = CategoryRendererHtml();
@@ -388,6 +389,20 @@ void main() {
       expect(renderer.renderLinkedName(category),
           '<a href="${HTMLBASE_PLACEHOLDER}topics/Superb-topic.html">Superb</a>');
     });
+
+    test('CategoryRendererMd renders category label', () {
+      Category category = packageGraph.publicPackages.first.categories.first;
+      CategoryRendererMd renderer = CategoryRendererMd();
+      expect(renderer.renderCategoryLabel(category),
+          '[Superb](${HTMLBASE_PLACEHOLDER}topics/Superb-topic.html)');
+    });
+
+    test('CategoryRendererMd renders linkedName', () {
+      Category category = packageGraph.publicPackages.first.categories.first;
+      CategoryRendererMd renderer = CategoryRendererMd();
+      expect(renderer.renderLinkedName(category),
+          '[Superb](${HTMLBASE_PLACEHOLDER}topics/Superb-topic.html)');
+    });
   });
 
   group('LibraryContainer', () {