Markdown template tweaks (#2162)

* Add some spacing

* Colon syntax for definition doesn't work, so remove it

* tweak features display

* Category tweaks

* Use h5

* Slightly more verbose source link

* Escape opening angle bracket on type parameters

Author: jdkoren

lib/src/model/categorization.dart

@@ -114,6 +114,8 @@ abstract class Categorization implements ModelElement {
     return categories.where((c) => c.isDocumented);
   }
 
+  bool get hasDisplayedCategories => displayedCategories.isNotEmpty;
+
   /// True if categories, subcategories, a documentation icon, or samples were
   /// declared.
   bool get hasCategorization {

lib/src/render/type_parameters_renderer.dart

@@ -49,6 +49,6 @@ class TypeParametersRendererMd extends TypeParametersRenderer {
       return '';
     }
     var joined = typeParameters.map(mapfn).join(', ');
-    return '<${joined}>';
+    return '&lt;${joined}>';
   }
 }

lib/templates/md/_accessor_getter.md

@@ -1,7 +1,8 @@
 {{#getter}}
-{{{ linkedReturnType }}} {{>name_summary}}
+{{{ linkedReturnType }}} {{>name_summary}}  {{!two spaces intentional}}
 {{>features}}
 
 {{>documentation}}
+
 {{>source_code}}
 {{/getter}}

lib/templates/md/_accessor_setter.md

@@ -1,7 +1,8 @@
 {{#setter}}
-{{>name_summary}}({{{ linkedParamsNoMetadata }}})
+{{>name_summary}}({{{ linkedParamsNoMetadata }}})  {{!two spaces intentional}}
 {{>features}}
 
 {{>documentation}}
+
 {{>source_code}}
 {{/setter}}

lib/templates/md/_callable.md

@@ -1,3 +1,5 @@
-{{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}} {{>categorization}}
-: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+##### {{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}}
+{{>categorization}}
+
+{{{ oneLineDoc }}} {{{ extendedDocLink }}}  {{!two spaces intentional}}
 {{>features}}

lib/templates/md/_categorization.md

@@ -1,5 +1,6 @@
-{{#hasCategoryNames}}
+{{#hasDisplayedCategories}}
+Categories:
 {{#displayedCategories}}
 {{{categoryLabel}}}
 {{/displayedCategories}}
-{{/hasCategoryNames}}
+{{/hasDisplayedCategories}}

lib/templates/md/_class.md

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

lib/templates/md/_constant.md

@@ -1,3 +1,5 @@
-{{{ linkedName }}} const {{{ linkedReturnType }}} {{>categorization}}
-: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+##### {{{ linkedName }}} const {{{ linkedReturnType }}}
+{{>categorization}}
+
+{{{ oneLineDoc }}} {{{ extendedDocLink }}}  {{!two spaces intentional}}
 {{>features}}

lib/templates/md/_extension.md

@@ -1,2 +1,4 @@
-{{{linkedName}}} {{>categorization}}
-: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+##### {{{linkedName}}}
+{{>categorization}}
+
+{{{ oneLineDoc }}} {{{ extendedDocLink }}}

lib/templates/md/_library.md

@@ -1,4 +1,5 @@
-{{{ linkedName }}} ({{>categorization}})
+##### {{{ linkedName }}}
 {{#isDocumented}}
-: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{{ oneLineDoc }}} {{{ extendedDocLink }}}
+
 {{/isDocumented}}