stdlib: new markup and docs generation

Author: vknabel

stdlib/README.md

@@ -6,14 +6,17 @@ Other modules are not imported implicitly.
 - [booleans](./booleans.md)
 - [cmp](./cmp.md)
 - [controls](./controls.md)
-- [docs](./docs.md)
 - [eq](./eq.md)
+- [docs](./docs.md)
 - [fs](./fs.md)
 - [lists](./lists.md)
+- [markdown](./markdown.md)
+- [markup](./markup.md)
 - [optionals](./optionals.md)
 - [os](./os.md)
 - [prelude](./prelude.md)
-- [results](./results.md)
+- [ranges](./ranges.md)
 - [rx](./rx.md)
+- [results](./results.md)
 - [strings](./strings.md)
 - [tests](./tests.md)

stdlib/booleans.md

@@ -1,6 +1,7 @@
 # booleans
 
-_module_ The booleans module declares more helpers around `prelude.Bool`.
+_module_
+The booleans module declares more helpers around `prelude.Bool`.
 Also see `prelude.if`, `prelude.when`, `prelude.unless`.
 
 - _func_ [not](#not) flag
@@ -10,4 +11,5 @@ Also see `prelude.if`, `prelude.when`, `prelude.unless`.
 _func_ `not flag`
 
 Transforms a given `Bool` into the opposing value.
-When flag is `True`, it will return `False` and vise versa.
+When flag is `True`, it will return `False` and vise versa.
+

stdlib/cmp.md

@@ -1,45 +1,46 @@
 # cmp
 
-_module_ Defines comparision operations, ascending and descending of values.
+_module_
+Defines comparision operations, ascending and descending of values.
 
 - _data_ [Ascending](#Ascending)
 - _data_ [Comparable](#Comparable)
 - _data_ [Descending](#Descending)
 - _data_ [Equal](#Equal)
 - _enum_ [Order](#Order)
-
 - _func_ [equatableFrom](#equatableFrom) comparableWitness
-
 - _func_ [pullback](#pullback) f, witness
 
 ## Ascending
 
-_data_ 
+_data_
+
 ## Comparable
 
-_data_ 
+_data_
 
 ### Properties
 
 - `compare lhs, rhs`
 
 ## Descending
 
-_data_ 
+_data_
+
 ## Equal
 
-_data_ 
+_data_
+
 ## Order
 
-_enum_ 
+_enum_
 
 ### Cases
 
 - [Ascending](#Ascending)
 - [Equal](#Equal)
 - [Descending](#Descending)
 
-
 ## equatableFrom
 
 _func_ `equatableFrom comparableWitness`

stdlib/controls.md

@@ -1,6 +1,6 @@
 # controls
 
-_module_ 
+_module_
 
 - _data_ [Contravariant](#Contravariant)
 - _enum_ [ContravariantWitness](#ContravariantWitness)
@@ -40,7 +40,8 @@ Invariants:
 
 ## ContravariantWitness
 
-_enum_ Defines all valid witnesses for a contravariant.
+_enum_
+Defines all valid witnesses for a contravariant.
 
 ```
 import cmp
@@ -84,7 +85,8 @@ Invariants:
 
 ## FunctorWitness
 
-_enum_ Defines all valid witnesses for a functor.
+_enum_
+Defines all valid witnesses for a functor.
 
 ```
 import lists
@@ -117,7 +119,8 @@ Invariants:
 
 ## MonadWitness
 
-_enum_ Valid witnesses for a monad.
+_enum_
+Valid witnesses for a monad.
 
 ```
 import lists
@@ -135,17 +138,14 @@ flatMap repeat 2, lists.monad
 
 _func_ `contravariantFrom moduleWitness`
 
-
 ## flatMap
 
 _func_ `flatMap f, witness, instance`
 
-
 ## functorFrom
 
 _func_ `functorFrom moduleWitness`
 
-
 ## map
 
 _func_ `map f, witness, value`
@@ -160,16 +160,15 @@ import lists
 let incr = { i => i + 1 }
 map incr, lists, [1, 2, 3]
 ```
+
 ## monadFrom
 
 _func_ `monadFrom monadWitness`
 
-
 ## pullback
 
 _func_ `pullback f, witness`
 
-
 ## pure
 
 _func_ `pure value, witness`

stdlib/docs.md

@@ -1,6 +1,6 @@
 # docs
 
-_module_ 
+_module_
 
 - _data_ [ConstantDocs](#ConstantDocs)
 - _data_ [DataDocs](#DataDocs)
@@ -13,16 +13,16 @@ _module_
 - _data_ [FunctionDocs](#FunctionDocs)
 - _data_ [ModuleDocs](#ModuleDocs)
 - _enum_ [TypeDocs](#TypeDocs)
-- _func_ [dataFieldDocsToMarkdown](#dataFieldDocsToMarkdown) field
+- _func_ [dataFieldDocsToMarkup](#dataFieldDocsToMarkup) field
 - _func_ [docsToMarkdown](#docsToMarkdown) docs
-- _func_ [enumCaseDocsToMarkdown](#enumCaseDocsToMarkdown) case
-- _extern_ [inspect](#inspect)
-- _func_ [markdownDocsSuffix](#markdownDocsSuffix) docsString
-- _func_ [moduleMemberDocsToMarkdown](#moduleMemberDocsToMarkdown) member
+- _func_ [docsToMarkup](#docsToMarkup)
+- _func_ [enumCaseDocsToMarkup](#enumCaseDocsToMarkup) case
+- _extern_ [inspect](#inspect) value
+- _func_ [moduleMemberDocsToMarkup](#moduleMemberDocsToMarkup)
 
 ## ConstantDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -31,7 +31,7 @@ _data_
 
 ## DataDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -81,7 +81,7 @@ _data_ Describes a field of a data type
 
 ## ExternFunctionDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -91,7 +91,7 @@ _data_
 
 ## ExternTypeDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -101,7 +101,7 @@ _data_
 
 ## FunctionDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -111,7 +111,7 @@ _data_
 
 ## ModuleDocs
 
-_data_ 
+_data_
 
 ### Properties
 
@@ -121,7 +121,8 @@ _data_
 
 ## TypeDocs
 
-_enum_ All possible docs inspection values.
+_enum_
+All possible docs inspection values.
 
 ### Cases
 
@@ -134,32 +135,26 @@ _enum_ All possible docs inspection values.
 - [ExternFunctionDocs](#ExternFunctionDocs)
 - [None](#None)
 
-## dataFieldDocsToMarkdown
-
-_func_ `dataFieldDocsToMarkdown field`
+## dataFieldDocsToMarkup
 
+_func_ `dataFieldDocsToMarkup field`
 
 ## docsToMarkdown
 
 _func_ `docsToMarkdown docs`
 
+## docsToMarkup
 
-## enumCaseDocsToMarkdown
+_func_ `docsToMarkup`
 
-_func_ `enumCaseDocsToMarkdown case`
+## enumCaseDocsToMarkup
 
+_func_ `enumCaseDocsToMarkup case`
 
 ## inspect
 
 _extern_ `inspect value`
 
+## moduleMemberDocsToMarkup
 
-## markdownDocsSuffix
-
-_func_ `markdownDocsSuffix docsString`
-
-
-## moduleMemberDocsToMarkdown
-
-_func_ `moduleMemberDocsToMarkdown member`
-
+_func_ `moduleMemberDocsToMarkup`