build: fix #185, update generate-readme & regenerate all

thi-ng · Dec 14, 2019 · c638bad · c638bad
1 parent 3271303
commit c638bad
Show file tree

Hide file tree

Showing 33 changed files with 166 additions and 125 deletions.
diff --git a/packages/associative/README.md b/packages/associative/README.md
@@ -10,7 +10,7 @@ This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
 
 - [About](#about)
-  - [Why?](#why-)
+  - [Why?](#why)
   - [Comparison with ES6 native types](#comparison-with-es6-native-types)
   - [Status](#status)
 - [Installation](#installation)
@@ -24,7 +24,7 @@ This project is part of the
   - [SortedMap](#sortedmap)
     - [Ranged queries](#ranged-queries)
   - [SortedSet](#sortedset)
-  - [SparseSet8/16/32](#sparseset8-16-32)
+  - [SparseSet8/16/32](#sparseset81632)
 - [Authors](#authors)
 - [License](#license)
 

diff --git a/packages/atom/README.md b/packages/atom/README.md
@@ -19,7 +19,7 @@ This project is part of the
   - [Transacted updates](#transacted-updates)
   - [Cursor](#cursor)
   - [Derived views](#derived-views)
-  - [Undo / Redo history](#undo---redo-history)
+  - [Undo / Redo history](#undo-redo-history)
 - [Authors](#authors)
 - [License](#license)
 

diff --git a/packages/bencode/README.md b/packages/bencode/README.md
@@ -10,7 +10,7 @@ This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
 
 - [About](#about)
-  - [Features / behaviors](#features---behaviors)
+  - [Features / behaviors](#features-behaviors)
     - [Booleans](#booleans)
     - [String handling](#string-handling)
     - [Floating point values](#floating-point-values)

diff --git a/packages/csp/README.md b/packages/csp/README.md
@@ -14,7 +14,7 @@ This project is part of the
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [API](#api)
-  - [File loading & word frequency analysis](#file-loading---word-frequency-analysis)
+  - [File loading & word frequency analysis](#file-loading--and--word-frequency-analysis)
   - [Channel merging](#channel-merging)
   - [PubSub](#pubsub)
 - [Authors](#authors)

diff --git a/packages/defmulti/README.md b/packages/defmulti/README.md
@@ -15,10 +15,10 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
 - [API](#api)
-  - [defmulti()](#defmulti--)
+  - [defmulti()](#defmulti)
     - [Dispatch value hierarchies](#dispatch-value-hierarchies)
-  - [implementations()](#implementations--)
-  - [defmultiN()](#defmultin--)
+  - [implementations()](#implementations)
+  - [defmultiN()](#defmultin)
 - [Usage examples](#usage-examples)
     - [Dynamic dispatch: Simple S-expression interpreter](#dynamic-dispatch--simple-s-expression-interpreter)
     - [True multiple arg dispatch](#true-multiple-arg-dispatch)

diff --git a/packages/diff/README.md b/packages/diff/README.md
@@ -15,7 +15,7 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [API](#api)
 - [Breaking changes](#breaking-changes)
-  - [2.0.0](#2-0-0)
+  - [2.0.0](#200)
 - [Authors](#authors)
 - [License](#license)
 

diff --git a/packages/hdom-canvas/README.md b/packages/hdom-canvas/README.md
@@ -17,20 +17,20 @@ This project is part of the
 - [Usage examples](#usage-examples)
 - [API](#api)
 - [How it works](#how-it-works)
-  - [Restrictions & behavior controls](#restrictions---behavior-controls)
+  - [Restrictions & behavior controls](#restrictions--and--behavior-controls)
   - [HDPI support](#hdpi-support)
 - [SVG conversion](#svg-conversion)
 - [Supported shape types](#supported-shape-types)
   - [Group](#group)
   - [Definition group](#definition-group)
   - [Circle](#circle)
   - [Circular arc](#circular-arc)
-  - [Ellipse / elliptic arc](#ellipse---elliptic-arc)
+  - [Ellipse / elliptic arc](#ellipse-elliptic-arc)
   - [Rect](#rect)
   - [Line](#line)
   - [Horizontal Line](#horizontal-line)
   - [Vertical Line](#vertical-line)
-  - [Polyline / Polygon](#polyline---polygon)
+  - [Polyline / Polygon](#polyline-polygon)
   - [Path](#path)
     - [SVG paths with arc segments](#svg-paths-with-arc-segments)
   - [Points](#points)
@@ -43,7 +43,7 @@ This project is part of the
     - [String](#string)
     - [Number](#number)
     - [Array](#array)
-    - [@thi.ng/color values](#-thi-ng-color-values)
+    - [@thi.ng/color values](#thingcolor-values)
   - [Coordinate transformations](#coordinate-transformations)
     - [Transform matrix](#transform-matrix)
     - [Override transform](#override-transform)
@@ -141,6 +141,14 @@ Animated sine plasma effect visualized using contour lines
 
 [Live demo](https://demo.thi.ng/umbrella/iso-plasma/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/iso-plasma)
 
+### ramp-synth <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/ramp-synth.png)
+
+TODO
+
+[Live demo](https://demo.thi.ng/umbrella/ramp-synth/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/ramp-synth)
+
 ### rotating-voronoi <!-- NOTOC -->
 
 ![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/rotating-voronoi.jpg)

diff --git a/packages/hdom/README.md b/packages/hdom/README.md
@@ -16,40 +16,40 @@ This project is part of the
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
-  - [Minimal example #1: Local state, RAF update](#minimal-example--1--local-state--raf-update)
-  - [Minimal example #2: Reactive, push-based state & update](#minimal-example--2--reactive--push-based-state---update)
-  - [Minimal example #3: Immutable app state & interceptors](#minimal-example--3--immutable-app-state---interceptors)
-  - [Minimal example #4: Canvas scene tree / branch-local behavior](#minimal-example--4--canvas-scene-tree---branch-local-behavior)
+  - [Minimal example #1: Local state, RAF update](#minimal-example-1--local-state--raf-update)
+  - [Minimal example #2: Reactive, push-based state & update](#minimal-example-2--reactive--push-based-state--and--update)
+  - [Minimal example #3: Immutable app state & interceptors](#minimal-example-3--immutable-app-state--and--interceptors)
+  - [Minimal example #4: Canvas scene tree / branch-local behavior](#minimal-example-4--canvas-scene-tree-branch-local-behavior)
 - [API](#api)
   - [The hdom data flow](#the-hdom-data-flow)
   - [Nested arrays](#nested-arrays)
   - [Attribute objects](#attribute-objects)
-  - [Pure functions and/or closures](#pure-functions-and-or-closures)
+  - [Pure functions and/or closures](#pure-functions-andor-closures)
   - [Iterators](#iterators)
   - [Interface support](#interface-support)
   - [Component objects with life cycle methods](#component-objects-with-life-cycle-methods)
-  - [Event & state handling options](#event---state-handling-options)
+  - [Event & state handling options](#event--and--state-handling-options)
   - [Event listener options](#event-listener-options)
   - [Reusable components](#reusable-components)
   - [Usage details](#usage-details)
-  - [start()](#start--)
+  - [start()](#start)
     - [Selective updates](#selective-updates)
-  - [renderOnce()](#renderonce--)
+  - [renderOnce()](#renderonce)
   - [HDOMOpts config options](#hdomopts-config-options)
   - [HDOMImplementation interface](#hdomimplementation-interface)
-  - [normalizeTree()](#normalizetree--)
-  - [diffTree()](#difftree--)
-  - [createTree()](#createtree--)
-  - [hydrateTree()](#hydratetree--)
+  - [normalizeTree()](#normalizetree)
+  - [diffTree()](#difftree)
+  - [createTree()](#createtree)
+  - [hydrateTree()](#hydratetree)
 - [User context](#user-context)
-  - [`value` attribute handling](#-value--attribute-handling)
+  - [`value` attribute handling](#value-attribute-handling)
   - [Behavior control attributes](#behavior-control-attributes)
-    - [\_\_impl](#----impl)
-    - [\_\_diff](#----diff)
-    - [\_\_normalize](#----normalize)
-    - [\_\_release](#----release)
-    - [\_\_serialize](#----serialize)
-    - [\_\_skip](#----skip)
+    - [\_\_impl](#impl)
+    - [\_\_diff](#diff)
+    - [\_\_normalize](#normalize)
+    - [\_\_release](#release)
+    - [\_\_serialize](#serialize)
+    - [\_\_skip](#skip)
   - [Benchmarks](#benchmarks)
 - [Authors](#authors)
   - [Maintainer](#maintainer)

diff --git a/packages/hiccup-css/README.md b/packages/hiccup-css/README.md
@@ -17,11 +17,11 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
 - [API](#api)
-  - [`css(rules: any, opts?: CSSOpts)`](#-css-rules--any--opts---cssopts--)
+  - [`css(rules: any, opts?: CSSOpts)`](#cssrules--any--opts--cssopts)
   - [Property formatting only](#property-formatting-only)
   - [Basic selectors](#basic-selectors)
-  - [Property object merging & re-use](#property-object-merging---re-use)
-  - [Iterators & CSS class scoping](#iterators---css-class-scoping)
+  - [Property object merging & re-use](#property-object-merging--and--re-use)
+  - [Iterators & CSS class scoping](#iterators--and--css-class-scoping)
   - [Nested selectors](#nested-selectors)
   - [Pseudo-classes](#pseudo-classes)
   - [Attribute selectors](#attribute-selectors)

diff --git a/packages/hiccup-markdown/README.md b/packages/hiccup-markdown/README.md
@@ -17,11 +17,11 @@ This project is part of the
 - [API](#api)
 - [Parser](#parser)
   - [Features](#features)
-  - [Current issues & limitations](#current-issues---limitations)
+  - [Current issues & limitations](#current-issues--and--limitations)
   - [Other parser features](#other-parser-features)
   - [Serializing to HTML](#serializing-to-html)
   - [Customizing tags](#customizing-tags)
-- [Serializer (Hiccup to Markdown)](#serializer--hiccup-to-markdown-)
+- [Serializer (Hiccup to Markdown)](#serializer-hiccup-to-markdown)
   - [Features](#features)
   - [Behaviors](#behaviors)
   - [Usage examples](#usage-examples)

diff --git a/packages/hiccup-svg/README.md b/packages/hiccup-svg/README.md
@@ -11,7 +11,7 @@ This project is part of the
 
 - [About](#about)
   - [Important](#important)
-  - [SVG conversion of @thi.ng/geom & @thi.ng/hdom-canvas shape trees](#svg-conversion-of--thi-ng-geom----thi-ng-hdom-canvas-shape-trees)
+  - [SVG conversion of @thi.ng/geom & @thi.ng/hdom-canvas shape trees](#svg-conversion-of-thinggeom--and--thinghdom-canvas-shape-trees)
   - [Automatic attribute conversions](#automatic-attribute-conversions)
     - [Colors](#colors)
     - [Transforms](#transforms)

diff --git a/packages/hiccup/README.md b/packages/hiccup/README.md
@@ -12,8 +12,8 @@ This project is part of the
 - [About](#about)
   - [Features](#features)
   - [Use cases](#use-cases)
-  - [No special sauce needed (or wanted)](#no-special-sauce-needed--or-wanted-)
-  - [What is Hiccup?](#what-is-hiccup-)
+  - [No special sauce needed (or wanted)](#no-special-sauce-needed-or-wanted)
+  - [What is Hiccup?](#what-is-hiccup)
   - [Status](#status)
   - [Support packages](#support-packages)
   - [Related packages](#related-packages)
@@ -26,16 +26,16 @@ This project is part of the
   - [Attributes](#attributes)
   - [Simple components](#simple-components)
   - [User context injection](#user-context-injection)
-  - [SVG generation, generators & lazy composition](#svg-generation--generators---lazy-composition)
+  - [SVG generation, generators & lazy composition](#svg-generation--generators--and--lazy-composition)
   - [Data-driven component composition](#data-driven-component-composition)
   - [Stateful component](#stateful-component)
   - [Component objects](#component-objects)
   - [Behavior control attributes](#behavior-control-attributes)
   - [Comments](#comments)
-  - [XML / DTD processing instructions](#xml---dtd-processing-instructions)
+  - [XML / DTD processing instructions](#xml-dtd-processing-instructions)
 - [API](#api)
-  - [serialize(tree: any, ctx?: any, escape = false): string](#serialize-tree--any--ctx---any--escape---false---string)
-  - [escape(str: string): string](#escape-str--string---string)
+  - [serialize(tree: any, ctx?: any, escape = false): string](#serializetree--any--ctx--any--escape--false--string)
+  - [escape(str: string): string](#escapestr--string--string)
 - [Authors](#authors)
 - [License](#license)
 

diff --git a/packages/idgen/README.md b/packages/idgen/README.md
@@ -15,7 +15,7 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [API](#api)
   - [ID generator with 16 bit range and no versioning](#id-generator-with-16-bit-range-and-no-versioning)
-  - [ID generator w/ 24 bit range & 8 bit version range](#id-generator-w--24-bit-range---8-bit-version-range)
+  - [ID generator w/ 24 bit range & 8 bit version range](#id-generator-w-24-bit-range--and--8-bit-version-range)
   - [IDGen is iterable](#idgen-is-iterable)
 - [Authors](#authors)
 - [License](#license)

diff --git a/packages/imgui/README.md b/packages/imgui/README.md
@@ -11,7 +11,7 @@ This project is part of the
 
 - [About](#about)
   - [Current features](#current-features)
-  - [Available components / widgets](#available-components---widgets)
+  - [Available components / widgets](#available-components-widgets)
   - [State handling](#state-handling)
   - [Layout support](#layout-support)
   - [Key controls](#key-controls)

diff --git a/packages/interceptors/README.md b/packages/interceptors/README.md
@@ -13,8 +13,8 @@ This project is part of the
 - [Event bus, interceptors, side effects](#event-bus--interceptors--side-effects)
   - [Interceptors: Event and Effect primitives](#interceptors--event-and-effect-primitives)
   - [Event Handlers](#event-handlers)
-    - [Events vs Effects:](#events-vs-effects-)
-  - [Great, but why?](#great--but-why-)
+    - [Events vs Effects:](#events-vs-effects)
+  - [Great, but why?](#great--but-why)
   - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)

diff --git a/packages/malloc/README.md b/packages/malloc/README.md
@@ -11,23 +11,23 @@ This project is part of the
 
 - [About](#about)
 - [Memory layout](#memory-layout)
-- [Free block compaction / coalescing](#free-block-compaction---coalescing)
+- [Free block compaction / coalescing](#free-block-compaction-coalescing)
 - [Block splitting](#block-splitting)
   - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [API](#api)
   - [MemPool](#mempool)
-  - [`malloc(size: number)`](#-malloc-size--number--)
-  - [`mallocAs(type: Type, num: number)`](#-mallocas-type--type--num--number--)
-  - [`calloc(size: number, fill = 0)`](#-calloc-size--number--fill---0--)
-  - [`callocAs(type: Type, num: number, fill = 0)`](#-callocas-type--type--num--number--fill---0--)
-  - [`realloc(addr: number, size: number)`](#-realloc-addr--number--size--number--)
-  - [`reallocArray(buf: TypedArray, num: number)`](#-reallocarray-buf--typedarray--num--number--)
-  - [`free(addr: number | TypedArray)`](#-free-addr--number---typedarray--)
-  - [`freeAll()`](#-freeall---)
-  - [`release()`](#-release---)
-  - [`stats()`](#-stats---)
+  - [`malloc(size: number)`](#mallocsize--number)
+  - [`mallocAs(type: Type, num: number)`](#mallocastype--type--num--number)
+  - [`calloc(size: number, fill = 0)`](#callocsize--number--fill--0)
+  - [`callocAs(type: Type, num: number, fill = 0)`](#callocastype--type--num--number--fill--0)
+  - [`realloc(addr: number, size: number)`](#reallocaddr--number--size--number)
+  - [`reallocArray(buf: TypedArray, num: number)`](#reallocarraybuf--typedarray--num--number)
+  - [`free(addr: number | TypedArray)`](#freeaddr--number--typedarray)
+  - [`freeAll()`](#freeall)
+  - [`release()`](#release)
+  - [`stats()`](#stats)
 - [Benchmarks](#benchmarks)
 - [Authors](#authors)
   - [Maintainer](#maintainer)

diff --git a/packages/math/README.md b/packages/math/README.md
@@ -80,6 +80,14 @@ Worker based, interactive Mandelbrot visualization
 
 [Live demo](https://demo.thi.ng/umbrella/mandelbrot/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/mandelbrot)
 
+### ramp-synth <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/ramp-synth.png)
+
+TODO
+
+[Live demo](https://demo.thi.ng/umbrella/ramp-synth/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/ramp-synth)
+
 ### scenegraph <!-- NOTOC -->
 
 ![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/scenegraph.png)

diff --git a/packages/matrices/README.md b/packages/matrices/README.md
@@ -21,12 +21,12 @@ This project is part of the
     - [WebGL related](#webgl-related)
   - [Matrix conversion](#matrix-conversion)
   - [Setters](#setters)
-  - [Row & column accessors](#row---column-accessors)
+  - [Row & column accessors](#row--and--column-accessors)
   - [Componentwise matrix - matrix](#componentwise-matrix---matrix)
   - [Componentwise matrix - scalar](#componentwise-matrix---scalar)
   - [Matrix multiplication](#matrix-multiplication)
   - [Matrix - vector multiplication](#matrix---vector-multiplication)
-  - [Determinant & inversion](#determinant---inversion)
+  - [Determinant & inversion](#determinant--and--inversion)
   - [Matrix transposition](#matrix-transposition)
   - [Quaternion](#quaternion)
 - [Authors](#authors)

diff --git a/packages/memoize/README.md b/packages/memoize/README.md
@@ -17,7 +17,7 @@ This project is part of the
 - [API](#api)
   - [Optimized version for single arg functions](#optimized-version-for-single-arg-functions)
   - [Arbitrary args](#arbitrary-args)
-  - [Via JSON.stringify()](#via-json-stringify--)
+  - [Via JSON.stringify()](#via-jsonstringify)
 - [Authors](#authors)
 - [License](#license)
 

diff --git a/packages/pointfree-lang/README.md b/packages/pointfree-lang/README.md
@@ -15,7 +15,7 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
 - [API](#api)
-- [Language & Syntax](#language---syntax)
+- [Language & Syntax](#language--and--syntax)
   - [Comments](#comments)
   - [Identifiers](#identifiers)
   - [Word definitions](#word-definitions)
@@ -24,12 +24,12 @@ This project is part of the
   - [Boolean](#boolean)
   - [Numbers](#numbers)
   - [Strings](#strings)
-  - [Quotations (Arrays)](#quotations--arrays-)
+  - [Quotations (Arrays)](#quotations-arrays)
   - [Literal quotes](#literal-quotes)
   - [Variables](#variables)
     - [Dynamic scoping](#dynamic-scoping)
   - [Objects](#objects)
-- [Ideas / Todos](#ideas---todos)
+- [Ideas / Todos](#ideas-todos)
 - [Authors](#authors)
 - [License](#license)