X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=README.md;h=68f91ea85a20c2247666df5b4c20f1820cc03420;hb=HEAD;hp=c6f92261925b04abe67a34bbce9b18906a51364d;hpb=a2c0e2fc57bb8f25f694e16eb4e51d6970b28829;p=squeep-html-template-helper diff --git a/README.md b/README.md index c6f9226..68f91ea 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Simplistic helpers for rendering HTML and boilerplate. Specific to Squeep Framework Applications, this module has strong opinions and makes many assumptions. +Expects `/static/theme.css` and `/static/custom.css` to exist. + ## API - `initContext(ctx)` @@ -19,18 +21,6 @@ Specific to Squeep Framework Applications, this module has strong opinions and m ### Context -The context is referenced for authenticated user information, as well as messaging. - -- `ctx.session.authenticatedIdentifier` -- `ctx.session.authenticatedProfile` - -If either of these are present, a navigation link is added to the page header allowing the user to log out. -The link will point relatively to `/admin/logout`. - -- `ctx.url` - -If present, added as a query parameter (`r`, for redirect) to the logout link. - - `ctx.errors` - `ctx.notifications` @@ -50,3 +40,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.