improved documentation headers

nowaalex · Mar 2, 2024 · fa51c71 · fa51c71
1 parent 1bd1c22
commit fa51c71
Show file tree

Hide file tree

Showing 65 changed files with 77 additions and 65 deletions.
diff --git a/website/build-docs.sh b/website/build-docs.sh
@@ -6,4 +6,7 @@ cp `find ../ -wholename *api-extractor-schema/*.json*` $REFERENCE_FILES_DIR
 npx api-documenter markdown -i $REFERENCE_FILES_DIR -o ./reference
 
 # clrf -> lf conversion for code blocks consistency
-dos2unix -q ./reference/**
+dos2unix -q ./reference/**
+
+# api-documenter is sophisticated, so converting first h2 to h1 in each file with bash
+find ./reference -type f -exec gawk -i inplace '!x{x=sub("## ","# ")}1' {} \;
diff --git a/website/reference/index.md b/website/reference/index.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md)
 
-## API Reference
+# API Reference
 
 ## Packages
 

diff --git a/website/reference/virtual-core.md b/website/reference/virtual-core.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md)
 
-## virtual-core package
+# virtual-core package
 
 Core framework-agnostic model.
 

diff --git a/website/reference/virtual-core.virtualscroller._constructor_.md b/website/reference/virtual-core.virtualscroller._constructor_.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [(constructor)](./virtual-core.virtualscroller._constructor_.md)
 
-## VirtualScroller.(constructor)
+# VirtualScroller.(constructor)
 
 Constructs a new instance of the `VirtualScroller` class
 

diff --git a/website/reference/virtual-core.virtualscroller.el.md b/website/reference/virtual-core.virtualscroller.el.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [el](./virtual-core.virtualscroller.el.md)
 
-## VirtualScroller.el() method
+# VirtualScroller.el() method
 
 Start/finish observing size of `element` at `index`<!-- -->. Observing is finished if element is `null`<!-- -->.
 

diff --git a/website/reference/virtual-core.virtualscroller.from.md b/website/reference/virtual-core.virtualscroller.from.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [from](./virtual-core.virtualscroller.from.md)
 
-## VirtualScroller.from property
+# VirtualScroller.from property
 
 Items range start with [overscanCount](./virtual-core.virtualscrollerruntimeparams.overscancount.md) included
 

diff --git a/website/reference/virtual-core.virtualscroller.getindex.md b/website/reference/virtual-core.virtualscroller.getindex.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [getIndex](./virtual-core.virtualscroller.getindex.md)
 
-## VirtualScroller.getIndex() method
+# VirtualScroller.getIndex() method
 
 Get item index by pixel offset;
 

diff --git a/website/reference/virtual-core.virtualscroller.getoffset.md b/website/reference/virtual-core.virtualscroller.getoffset.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [getOffset](./virtual-core.virtualscroller.getoffset.md)
 
-## VirtualScroller.getOffset() method
+# VirtualScroller.getOffset() method
 
 Get pixel offset by item index;
 

diff --git a/website/reference/virtual-core.virtualscroller.getsize.md b/website/reference/virtual-core.virtualscroller.getsize.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [getSize](./virtual-core.virtualscroller.getsize.md)
 
-## VirtualScroller.getSize() method
+# VirtualScroller.getSize() method
 
 Get last cached item size by item index
 

diff --git a/website/reference/virtual-core.virtualscroller.horizontal.md b/website/reference/virtual-core.virtualscroller.horizontal.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [horizontal](./virtual-core.virtualscroller.horizontal.md)
 
-## VirtualScroller.horizontal property
+# VirtualScroller.horizontal property
 
 Scroll container orientation.
 

diff --git a/website/reference/virtual-core.virtualscroller.md b/website/reference/virtual-core.virtualscroller.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md)
 
-## VirtualScroller class
+# VirtualScroller class
 
 Core framework-agnostic model.
 

diff --git a/website/reference/virtual-core.virtualscroller.on.md b/website/reference/virtual-core.virtualscroller.on.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [on](./virtual-core.virtualscroller.on.md)
 
-## VirtualScroller.on() method
+# VirtualScroller.on() method
 
 Subscribe to model events
 

diff --git a/website/reference/virtual-core.virtualscroller.scrollsize.md b/website/reference/virtual-core.virtualscroller.scrollsize.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [scrollSize](./virtual-core.virtualscroller.scrollsize.md)
 
-## VirtualScroller.scrollSize property
+# VirtualScroller.scrollSize property
 
 Sum of all item sizes
 

diff --git a/website/reference/virtual-core.virtualscroller.scrolltoindex.md b/website/reference/virtual-core.virtualscroller.scrolltoindex.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [scrollToIndex](./virtual-core.virtualscroller.scrolltoindex.md)
 
-## VirtualScroller.scrollToIndex() method
+# VirtualScroller.scrollToIndex() method
 
 Scroll to item index
 

diff --git a/website/reference/virtual-core.virtualscroller.scrolltooffset.md b/website/reference/virtual-core.virtualscroller.scrolltooffset.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [scrollToOffset](./virtual-core.virtualscroller.scrolltooffset.md)
 
-## VirtualScroller.scrollToOffset() method
+# VirtualScroller.scrollToOffset() method
 
 Scroll to pixel offset
 

diff --git a/website/reference/virtual-core.virtualscroller.set.md b/website/reference/virtual-core.virtualscroller.set.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [set](./virtual-core.virtualscroller.set.md)
 
-## VirtualScroller.set() method
+# VirtualScroller.set() method
 
 Synchronize runtime parameters
 

diff --git a/website/reference/virtual-core.virtualscroller.setcontainer.md b/website/reference/virtual-core.virtualscroller.setcontainer.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [setContainer](./virtual-core.virtualscroller.setcontainer.md)
 
-## VirtualScroller.setContainer() method
+# VirtualScroller.setContainer() method
 
 Informs model about items container element. Usually not needed.
 

diff --git a/website/reference/virtual-core.virtualscroller.setitemcount.md b/website/reference/virtual-core.virtualscroller.setitemcount.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [setItemCount](./virtual-core.virtualscroller.setitemcount.md)
 
-## VirtualScroller.setItemCount() method
+# VirtualScroller.setItemCount() method
 
 Notify model about items quantity change
 

diff --git a/website/reference/virtual-core.virtualscroller.setscroller.md b/website/reference/virtual-core.virtualscroller.setscroller.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [setScroller](./virtual-core.virtualscroller.setscroller.md)
 
-## VirtualScroller.setScroller() method
+# VirtualScroller.setScroller() method
 
 Informs model about scrollable element.
 

diff --git a/website/reference/virtual-core.virtualscroller.setstickyfooter.md b/website/reference/virtual-core.virtualscroller.setstickyfooter.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [setStickyFooter](./virtual-core.virtualscroller.setstickyfooter.md)
 
-## VirtualScroller.setStickyFooter() method
+# VirtualScroller.setStickyFooter() method
 
 Start observing size of sticky footer `element`<!-- -->. Observing is finished if element is `null`<!-- -->.
 

diff --git a/website/reference/virtual-core.virtualscroller.setstickyheader.md b/website/reference/virtual-core.virtualscroller.setstickyheader.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [setStickyHeader](./virtual-core.virtualscroller.setstickyheader.md)
 
-## VirtualScroller.setStickyHeader() method
+# VirtualScroller.setStickyHeader() method
 
 Start observing size of sticky header `element`<!-- -->. Observing is finished if element is `null`<!-- -->.
 

diff --git a/website/reference/virtual-core.virtualscroller.sizeshash.md b/website/reference/virtual-core.virtualscroller.sizeshash.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [sizesHash](./virtual-core.virtualscroller.sizeshash.md)
 
-## VirtualScroller.sizesHash property
+# VirtualScroller.sizesHash property
 
 Hash of item sizes. Changed when at least one visible item is resized
 

diff --git a/website/reference/virtual-core.virtualscroller.to.md b/website/reference/virtual-core.virtualscroller.to.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [to](./virtual-core.virtualscroller.to.md)
 
-## VirtualScroller.to property
+# VirtualScroller.to property
 
 Items range end with [overscanCount](./virtual-core.virtualscrollerruntimeparams.overscancount.md) included
 

diff --git a/website/reference/virtual-core.virtualscroller.updatescrolleroffset.md b/website/reference/virtual-core.virtualscroller.updatescrolleroffset.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [updateScrollerOffset](./virtual-core.virtualscroller.updatescrolleroffset.md)
 
-## VirtualScroller.updateScrollerOffset() method
+# VirtualScroller.updateScrollerOffset() method
 
 Recalculates the offset between [scroller element](./virtual-core.virtualscroller.setscroller.md) and [container element](./virtual-core.virtualscroller.setcontainer.md)<!-- -->.
 

diff --git a/website/reference/virtual-core.virtualscroller.visiblefrom.md b/website/reference/virtual-core.virtualscroller.visiblefrom.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScroller](./virtual-core.virtualscroller.md) &gt; [visibleFrom](./virtual-core.virtualscroller.visiblefrom.md)
 
-## VirtualScroller.visibleFrom property
+# VirtualScroller.visibleFrom property
 
 Returns snapshot of current scroll position.
 

diff --git a/website/reference/virtual-core.virtualscrollerevent.md b/website/reference/virtual-core.virtualscrollerevent.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerEvent](./virtual-core.virtualscrollerevent.md)
 
-## VirtualScrollerEvent variable
+# VirtualScrollerEvent variable
 
 Possible events, supported by [VirtualScroller.on()](./virtual-core.virtualscroller.on.md) method
 

diff --git a/website/reference/virtual-core.virtualscrollerexactposition.md b/website/reference/virtual-core.virtualscrollerexactposition.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerExactPosition](./virtual-core.virtualscrollerexactposition.md)
 
-## VirtualScrollerExactPosition type
+# VirtualScrollerExactPosition type
 
 Numeric snapshot of scroll position
 

diff --git a/...rence/virtual-core.virtualscrollerinitialparams.estimatedscrollelementoffset.md b/...rence/virtual-core.virtualscrollerinitialparams.estimatedscrollelementoffset.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerInitialParams](./virtual-core.virtualscrollerinitialparams.md) &gt; [estimatedScrollElementOffset](./virtual-core.virtualscrollerinitialparams.estimatedscrollelementoffset.md)
 
-## VirtualScrollerInitialParams.estimatedScrollElementOffset property
+# VirtualScrollerInitialParams.estimatedScrollElementOffset property
 
 Estimated distance between top/left edges of scrollable container and first scrollable item.
 

diff --git a/website/reference/virtual-core.virtualscrollerinitialparams.estimatedwidgetsize.md b/website/reference/virtual-core.virtualscrollerinitialparams.estimatedwidgetsize.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerInitialParams](./virtual-core.virtualscrollerinitialparams.md) &gt; [estimatedWidgetSize](./virtual-core.virtualscrollerinitialparams.estimatedwidgetsize.md)
 
-## VirtualScrollerInitialParams.estimatedWidgetSize property
+# VirtualScrollerInitialParams.estimatedWidgetSize property
 
 Estimated size of scroll element.
 

diff --git a/website/reference/virtual-core.virtualscrollerinitialparams.horizontal.md b/website/reference/virtual-core.virtualscrollerinitialparams.horizontal.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerInitialParams](./virtual-core.virtualscrollerinitialparams.md) &gt; [horizontal](./virtual-core.virtualscrollerinitialparams.horizontal.md)
 
-## VirtualScrollerInitialParams.horizontal property
+# VirtualScrollerInitialParams.horizontal property
 
 Scroll container orientation.
 

diff --git a/website/reference/virtual-core.virtualscrollerinitialparams.md b/website/reference/virtual-core.virtualscrollerinitialparams.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerInitialParams](./virtual-core.virtualscrollerinitialparams.md)
 
-## VirtualScrollerInitialParams interface
+# VirtualScrollerInitialParams interface
 
 All [VirtualScroller](./virtual-core.virtualscroller.md) parameters (that may / may not change over time).
 

diff --git a/website/reference/virtual-core.virtualscrollerruntimeparams.estimateditemsize.md b/website/reference/virtual-core.virtualscrollerruntimeparams.estimateditemsize.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerRuntimeParams](./virtual-core.virtualscrollerruntimeparams.md) &gt; [estimatedItemSize](./virtual-core.virtualscrollerruntimeparams.estimateditemsize.md)
 
-## VirtualScrollerRuntimeParams.estimatedItemSize property
+# VirtualScrollerRuntimeParams.estimatedItemSize property
 
 Estimated height/width of scrollable item. Orientation is determined by [VirtualScrollerInitialParams.horizontal](./virtual-core.virtualscrollerinitialparams.horizontal.md)<!-- -->.
 

diff --git a/website/reference/virtual-core.virtualscrollerruntimeparams.itemcount.md b/website/reference/virtual-core.virtualscrollerruntimeparams.itemcount.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerRuntimeParams](./virtual-core.virtualscrollerruntimeparams.md) &gt; [itemCount](./virtual-core.virtualscrollerruntimeparams.itemcount.md)
 
-## VirtualScrollerRuntimeParams.itemCount property
+# VirtualScrollerRuntimeParams.itemCount property
 
 Total items quantity
 

diff --git a/website/reference/virtual-core.virtualscrollerruntimeparams.md b/website/reference/virtual-core.virtualscrollerruntimeparams.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerRuntimeParams](./virtual-core.virtualscrollerruntimeparams.md)
 
-## VirtualScrollerRuntimeParams interface
+# VirtualScrollerRuntimeParams interface
 
 [VirtualScroller](./virtual-core.virtualscroller.md) parameters that may change over time. Used as [VirtualScroller.set()](./virtual-core.virtualscroller.set.md) argument type.
 

diff --git a/website/reference/virtual-core.virtualscrollerruntimeparams.overscancount.md b/website/reference/virtual-core.virtualscrollerruntimeparams.overscancount.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerRuntimeParams](./virtual-core.virtualscrollerruntimeparams.md) &gt; [overscanCount](./virtual-core.virtualscrollerruntimeparams.overscancount.md)
 
-## VirtualScrollerRuntimeParams.overscanCount property
+# VirtualScrollerRuntimeParams.overscanCount property
 
 Amount of items rendered before or after visible ones.
 

diff --git a/website/reference/virtual-core.virtualscrollerscrollelement.md b/website/reference/virtual-core.virtualscrollerscrollelement.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-core](./virtual-core.md) &gt; [VirtualScrollerScrollElement](./virtual-core.virtualscrollerscrollelement.md)
 
-## VirtualScrollerScrollElement type
+# VirtualScrollerScrollElement type
 
 Scrollable container type
 

diff --git a/website/reference/virtual-react.list.md b/website/reference/virtual-react.list.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [List](./virtual-react.list.md)
 
-## List() function
+# List() function
 
 React component. Small abstraction, which in 90% cases allows to avoid hook boilerplate.
 

diff --git a/website/reference/virtual-react.listitemprops.data.md b/website/reference/virtual-react.listitemprops.data.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListItemProps](./virtual-react.listitemprops.md) &gt; [data](./virtual-react.listitemprops.data.md)
 
-## ListItemProps.data property
+# ListItemProps.data property
 
 links to [ListProps.itemData](./virtual-react.listprops.itemdata.md)
 

diff --git a/website/reference/virtual-react.listitemprops.i.md b/website/reference/virtual-react.listitemprops.i.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListItemProps](./virtual-react.listitemprops.md) &gt; [i](./virtual-react.listitemprops.i.md)
 
-## ListItemProps.i property
+# ListItemProps.i property
 
 item index
 

diff --git a/website/reference/virtual-react.listitemprops.md b/website/reference/virtual-react.listitemprops.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListItemProps](./virtual-react.listitemprops.md)
 
-## ListItemProps interface
+# ListItemProps interface
 
 Props passed to List item
 

diff --git a/website/reference/virtual-react.listitemprops.model.md b/website/reference/virtual-react.listitemprops.model.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListItemProps](./virtual-react.listitemprops.md) &gt; [model](./virtual-react.listitemprops.model.md)
 
-## ListItemProps.model property
+# ListItemProps.model property
 
 **Signature:**
 

diff --git a/website/reference/virtual-react.listitemprops.offset.md b/website/reference/virtual-react.listitemprops.offset.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListItemProps](./virtual-react.listitemprops.md) &gt; [offset](./virtual-react.listitemprops.offset.md)
 
-## ListItemProps.offset property
+# ListItemProps.offset property
 
 **Signature:**
 

diff --git a/website/reference/virtual-react.listprops.children.md b/website/reference/virtual-react.listprops.children.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListProps](./virtual-react.listprops.md) &gt; [children](./virtual-react.listprops.children.md)
 
-## ListProps.children property
+# ListProps.children property
 
 **Signature:**
 

diff --git a/website/reference/virtual-react.listprops.component.md b/website/reference/virtual-react.listprops.component.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@af-utils/virtual-react](./virtual-react.md) &gt; [ListProps](./virtual-react.listprops.md) &gt; [component](./virtual-react.listprops.component.md)
 
-## ListProps.component property
+# ListProps.component property
 
 **Signature:**