aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorthe lemons <citrons@mondecitronne.com>2021-09-17 14:02:03 -0500
committerthe lemons <citrons@mondecitronne.com>2021-09-17 14:02:03 -0500
commitb012a710e503965cd5069084d52c65335c178f86 (patch)
treec9fa52ea397816690f9eb6e8166c9eac8a34e90d
parent5f1744c5b0f9761db402dfbca9cc85e1542ddb5f (diff)
readme
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8700e8b..d4c1ff4 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,8 @@ calling a tag's function with no arguments produces a self-closing tag.
### output
<hr />
+****
+
calling a tag's function with a single array or value argument produces a tag with the children provided in the array. non-table values may appear in the list of children or in its stead. they are converted to a string an escaped.
### source
@@ -18,6 +20,8 @@ calling a tag's function with a single array or value argument produces a tag wi
### output
<section><h1>foo</h1><p>bar</p></section>
+****
+
calling a tag's function with a single set of key/value pairs as the argument produces a self-closing tag with attributes corresponding to the key/value pairs
### source
@@ -25,6 +29,8 @@ calling a tag's function with a single set of key/value pairs as the argument pr
### output
<meta charset="utf-8" />
+****
+
calling a tag's function with a set of key/value pairs and then an array or value as the arguments produces a tag with attributes corresponding to the key/value pairs.
### source
@@ -32,6 +38,8 @@ calling a tag's function with a set of key/value pairs and then an array or valu
### output
<a href="https://example.com">foobar</a>
+****
+
a table used in a list of children must either be generated from the HTML functions or have a `tohtml` function or a `render` function, returning HTML structures or HTML source respectively. a table that is not a set of attributes or an array of element children may not be used as arguments to an HTML function.
### source
@@ -47,6 +55,8 @@ a table used in a list of children must either be generated from the HTML functi
### output
<p>search result: <a href="https://example.com/256">foobar</a></p>
+****
+
the `raw` function will insert text verbatim into the HTML, unescaped.
### source