X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=README.md;h=205bbc51ce4bbecd3e21dfcda218aebe9a96f4b6;hb=12a56b9b35eeb6181ce1d4b4fa2a0536984374d8;hp=66d16fd19dcee2f060d972d0944fce7192cec45f;hpb=4ab85bf22ece77cccd4e92435208bca5858816f6;p=squeep-html-template-helper diff --git a/README.md b/README.md index 66d16fd..205bbc5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,16 @@ Specific to Squeep Framework Applications, this module has strong opinions and m ## API -`htmlPage(pagePathLevel, ctx, options, main = [])` +- `initContext(ctx)` +- `htmlPage(pagePathLevel, ctx, options, main = [])` +- `dateOrNot(date, otherwise)` +- `dateFormat(date, pInf nInf, otherwise)` +- `timeElement(date, options)` +- `secondsToPeriod(seconds)` +- `indented(intent, list)` +- `UL(items, indent, attributes, itemAttributesGenerator)` +- `OL(items, indent, attributes, itemAttributesGenerator)` +- `LI(item, indent, attributes)` ### Context @@ -26,6 +35,7 @@ If present, added as a query parameter (`r`, for redirect) to the logout link. - `ctx.notifications` Lists of errors and notices to show at top of page, before main content. +`initContext` will create the arrays. ### Options @@ -40,3 +50,7 @@ Lists of errors and notices to show at top of page, before main content. - `options.notificationHeading` - h2 for notice section - `options.notificationContent` - additional information included ahead of list of notices - `options.` + +## Tests + +`LintHtml` class is a simple wrapper around html-validate package which can report issues with generated html strings.