Create some initial templates for md (#2145)

jdkoren · web-flow · commit bf9f5688c6a0 · 2020-02-25T09:39:35.000-08:00
* Create some initial templates for md

* Add footer, include head and footer in other templates

* Fix in enum template
diff --git a/lib/src/model/category.dart b/lib/src/model/category.dart
@@ -127,7 +127,7 @@ class Category extends Nameable
   @override
   String get href => isCanonical ? '${package.baseHref}$filePath' : null;
 
-  String get categorization => _categoryRenderer.renderCategoryLabel(this);
+  String get categoryLabel => _categoryRenderer.renderCategoryLabel(this);
 
   String get linkedName => _categoryRenderer.renderLinkedName(this);
 
diff --git a/lib/templates/html/_categorization.html b/lib/templates/html/_categorization.html
@@ -1,5 +1,5 @@
 {{#hasCategoryNames}}
   {{#displayedCategories}}
-    {{{categorization}}}
+    {{{categoryLabel}}}
   {{/displayedCategories}}
 {{/hasCategoryNames}}
diff --git a/lib/templates/md/404error.md b/lib/templates/md/404error.md
@@ -0,0 +1,6 @@
+# 404
+
+Oops, something's gone wrong :-(
+
+You've tried to visit a page that doesn't exist. Luckily this site has other
+[pages](index.md).
diff --git a/lib/templates/md/_accessor_getter.md b/lib/templates/md/_accessor_getter.md
@@ -0,0 +1,7 @@
+{{#getter}}
+{{{ linkedReturnType }}} {{>name_summary}}
+{{>features}}
+
+{{>documentation}}
+{{>source_code}}
+{{/getter}}
diff --git a/lib/templates/md/_accessor_setter.md b/lib/templates/md/_accessor_setter.md
@@ -0,0 +1,7 @@
+{{#setter}}
+{{>name_summary}}({{{ linkedParamsNoMetadata }}})
+{{>features}}
+
+{{>documentation}}
+{{>source_code}}
+{{/setter}}
diff --git a/lib/templates/md/_callable.md b/lib/templates/md/_callable.md
@@ -0,0 +1,3 @@
+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{>features}}
diff --git a/lib/templates/md/_callable_multiline.md b/lib/templates/md/_callable_multiline.md
@@ -0,0 +1,7 @@
+{{#hasAnnotations}}
+{{#annotations}}
+- {{{.}}}
+{{/annotations}}
+{{/hasAnnotations}}
+
+{{{ linkedReturnType }}} {{>name_summary}}{{{genericParameters}}}({{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}})
diff --git a/lib/templates/md/_categorization.md b/lib/templates/md/_categorization.md
@@ -0,0 +1,5 @@
+{{#hasCategoryNames}}
+{{#displayedCategories}}
+{{{categoryLabel}}}
+{{/displayedCategories}}
+{{/hasCategoryNames}}
diff --git a/lib/templates/md/_class.md b/lib/templates/md/_class.md
@@ -0,0 +1,2 @@
+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
diff --git a/lib/templates/md/_constant.md b/lib/templates/md/_constant.md
@@ -0,0 +1,3 @@
+{{#isDeprecated}}~~{{/isDeprecated}}{{{ linkedName }}} const {{{ linkedReturnType }}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{>features}}
diff --git a/lib/templates/md/_documentation.md b/lib/templates/md/_documentation.md
@@ -0,0 +1,3 @@
+{{#hasDocumentation}}
+{{{ documentationAsHtml }}}
+{{/hasDocumentation}}
diff --git a/lib/templates/md/_extension.md b/lib/templates/md/_extension.md
@@ -0,0 +1,2 @@
+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
diff --git a/lib/templates/md/_features.md b/lib/templates/md/_features.md
@@ -0,0 +1 @@
+{{ #featuresAsString.isNotEmpty }}_{{{featuresAsString}}}_{{ /featuresAsString.isNotEmpty }}
diff --git a/lib/templates/md/_footer.md b/lib/templates/md/_footer.md
@@ -0,0 +1,3 @@
+{{! markdown has no dedicated footer element, so both placeholders are siblings }}
+{{! footer-text placeholder }}
+{{! footer placeholder }}
diff --git a/lib/templates/md/_head.md b/lib/templates/md/_head.md
@@ -0,0 +1 @@
+{{! header placeholder }}
diff --git a/lib/templates/md/_library.md b/lib/templates/md/_library.md
@@ -0,0 +1,4 @@
+{{{ linkedName }}} ({{>categorization}})
+{{#isDocumented}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{/isDocumented}}
diff --git a/lib/templates/md/_mixin.md b/lib/templates/md/_mixin.md
@@ -0,0 +1,2 @@
+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
diff --git a/lib/templates/md/_name_summary.md b/lib/templates/md/_name_summary.md
@@ -0,0 +1 @@
+{{#isConst}}const {{/isConst}}{{#isDeprecated}}~~{{/isDeprecated}}{{name}}{{#isDeprecated}}~~{{/isDeprecated}}
diff --git a/lib/templates/md/_property.md b/lib/templates/md/_property.md
@@ -0,0 +1,3 @@
+{{{linkedName}}} {{{ arrow }}} {{{ linkedReturnType }}} {{>categorization}}
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{>features}}
diff --git a/lib/templates/md/_source_code.md b/lib/templates/md/_source_code.md
@@ -0,0 +1,7 @@
+{{#hasSourceCode}}
+## Implementation
+
+```dart
+{{{ sourceCode }}}
+```
+{{/hasSourceCode}}
diff --git a/lib/templates/md/_source_link.md b/lib/templates/md/_source_link.md
@@ -0,0 +1,3 @@
+{{#hasSourceHref}}
+[source]({{{sourceHref}}})
+{{/hasSourceHref}}
diff --git a/lib/templates/md/category.md b/lib/templates/md/category.md
@@ -0,0 +1,81 @@
+{{>head}}
+
+{{#self}}
+# {{name}} {{kind}}
+
+{{>documentation}}
+
+{{#hasPublicLibraries}}
+## Libraries
+
+{{#publicLibraries}}
+{{>library}}
+{{/publicLibraries}}
+{{/hasPublicLibraries}}
+
+{{#hasPublicClasses}}
+## Classes
+
+{{#publicClasses}}
+{{>class}}
+{{/publicClasses}}
+{{/hasPublicClasses}}
+
+{{#hasPublicMixins}}
+## Mixins
+
+{{#publicMixins}}
+{{>mixin}}
+{{/publicMixins}}
+{{/hasPublicMixins}}
+
+{{#hasPublicConstants}}
+## Constants
+
+{{#publicConstants}}
+{{>constant}}
+{{/publicConstants}}
+{{/hasPublicConstants}}
+
+{{#hasPublicProperties}}
+## Properties
+
+{{#publicProperties}}
+{{>property}}
+{{/publicProperties}}
+{{/hasPublicProperties}}
+
+{{#hasPublicFunctions}}
+## Functions
+
+{{#publicFunctions}}
+{{>callable}}
+{{/publicFunctions}}
+{{/hasPublicFunctions}}
+
+{{#hasPublicEnums}}
+## Enums
+
+{{#publicEnums}}
+{{>class}}
+{{/publicEnums}}
+{{/hasPublicEnums}}
+
+{{#hasPublicTypedefs}}
+## Typedefs
+
+{{#publicTypedefs}}
+{{>callable}}
+{{/publicTypedefs}}
+{{/hasPublicTypedefs}}
+
+{{#hasPublicExceptions}}
+## Exceptions / Errors
+
+{{#publicExceptions}}
+{{>class}}
+{{/publicExceptions}}
+{{/hasPublicExceptions}}
+{{/self}}
+
+{{>footer}}
diff --git a/lib/templates/md/class.md b/lib/templates/md/class.md
@@ -0,0 +1,124 @@
+{{>head}}
+
+{{#self}}
+# {{{nameWithGenerics}}} {{kind}}
+
+{{>source_link}}
+{{>categorization}}
+{{/self}}
+
+{{#clazz}}
+{{>documentation}}
+
+{{#hasModifiers}}
+{{#hasPublicSuperChainReversed}}
+**Inheritance**
+
+- {{{linkedObjectType}}}
+{{#publicSuperChainReversed}}
+- {{{linkedName}}}
+{{/publicSuperChainReversed}}
+- {{{name}}}
+{{/hasPublicSuperChainReversed}}
+
+{{#hasPublicInterfaces}}
+**Implemented types**
+
+{{#publicInterfaces}}
+- {{{linkedName}}}
+{{/publicInterfaces}}
+{{/hasPublicInterfaces}}
+
+{{#hasPublicMixins}}
+**Mixed in types**
+
+{{#publicMixins}}
+- {{{linkedName}}}
+{{/publicMixins}}
+{{/hasPublicMixins}}
+
+{{#hasPublicImplementors}}
+**Implementers**
+
+{{#publicImplementors}}
+- {{{linkedName}}}
+{{/publicImplementors}}
+{{/hasPublicImplementors}}
+
+{{#hasPotentiallyApplicableExtensions}}
+**Available Extensions**
+
+{{#potentiallyApplicableExtensions}}
+- {{{linkedName}}}
+{{/potentiallyApplicableExtensions}}
+{{/hasPotentiallyApplicableExtensions}}
+
+{{#hasAnnotations}}
+**Annotations**
+
+{{#annotations}}
+- {{{.}}}
+{{/annotations}}
+{{/hasAnnotations}}
+{{/hasModifiers}}
+
+{{#hasPublicConstructors}}
+## Constructors
+
+{{#publicConstructors}}
+{{{linkedName}}} ({{{ linkedParams }}})
+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}
+{{#isConst}}const{{/isConst}} {{#isFactory}}factory{{/isFactory}}
+{{/publicConstructors}}
+{{/hasPublicConstructors}}
+
+{{#hasPublicProperties}}
+## Properties
+
+{{#allPublicInstanceProperties}}
+{{>property}}
+{{/allPublicInstanceProperties}}
+{{/hasPublicProperties}}
+
+{{#hasPublicMethods}}
+## Methods
+
+{{#allPublicInstanceMethods}}
+{{>callable}}
+{{/allPublicInstanceMethods}}
+{{/hasPublicMethods}}
+
+{{#hasPublicOperators}}
+## Operators
+
+{{#allPublicOperators}}
+{{>callable}}
+{{/allPublicOperators}}
+{{/hasPublicOperators}}
+
+{{#hasPublicStaticProperties}}
+## Static Properties
+
+{{#publicStaticProperties}}
+{{>property}}
+{{/publicStaticProperties}}
+{{/hasPublicStaticProperties}}
+
+{{#hasPublicStaticMethods}}
+## Static Methods
+
+{{#publicStaticMethods}}
+{{>callable}}
+{{/publicStaticMethods}}
+{{/hasPublicStaticMethods}}
+
+{{#hasPublicConstants}}
+## Constants
+
+{{#publicConstants}}
+{{>constant}}
+{{/publicConstants}}
+{{/hasPublicConstants}}
+{{/clazz}}
+
+{{>footer}}
diff --git a/lib/templates/md/constant.md b/lib/templates/md/constant.md
@@ -0,0 +1,16 @@
+{{>head}}
+
+{{#self}}
+# {{{name}}} {{kind}}
+
+{{>source_link}}
+{{/self}}
+
+{{#property}}
+{{{ linkedReturnType }}} {{>name_summary}} = {{{ constantValue }}}
+
+{{>documentation}}
+{{>source_code}}
+{{/property}}
+
+{{>footer}}
diff --git a/lib/templates/md/constructor.md b/lib/templates/md/constructor.md
@@ -0,0 +1,25 @@
+{{>head}}
+
+{{#self}}
+# {{{nameWithGenerics}}} {{kind}}
+
+{{>source_link}}
+{{/self}}
+
+{{#constructor}}
+{{#hasAnnotations}}
+{{#annotations}}
+- {{{.}}}
+{{/annotations}}
+{{/hasAnnotations}}
+
+{{#isConst}}const{{/isConst}}
+{{#isDeprecated}}~~{{/isDeprecated}}{{{nameWithGenerics}}}({{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}}){{#isDeprecated}}~~{{/isDeprecated}}
+
+{{>documentation}}
+
+{{>source_code}}
+
+{{/constructor}}
+
+{{>footer}}
diff --git a/lib/templates/md/enum.md b/lib/templates/md/enum.md
diff --git a/lib/templates/md/extension.md b/lib/templates/md/extension.md
diff --git a/lib/templates/md/function.md b/lib/templates/md/function.md
diff --git a/lib/templates/md/index.md b/lib/templates/md/index.md
diff --git a/lib/templates/md/library.md b/lib/templates/md/library.md
diff --git a/lib/templates/md/method.md b/lib/templates/md/method.md
diff --git a/lib/templates/md/mixin.md b/lib/templates/md/mixin.md
diff --git a/lib/templates/md/property.md b/lib/templates/md/property.md
diff --git a/lib/templates/md/top_level_constant.md b/lib/templates/md/top_level_constant.md
diff --git a/lib/templates/md/top_level_property.md b/lib/templates/md/top_level_property.md
diff --git a/lib/templates/md/typedef.md b/lib/templates/md/typedef.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}}({{{ linkedParamsNoMetadata }}}) {{{ linkedReturnType }}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}`
	`2`	`+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}`
	`3`	`+{{>features}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+{{#isDeprecated}}~~{{/isDeprecated}}{{{linkedName}}}{{{linkedGenericParameters}}} {{>categorization}}{{#isDeprecated}}~~{{/isDeprecated}}`
	`2`	`+: {{{ oneLineDoc }}} {{{ extendedDocLink }}}`