Document Text/Textf helpers better Both in the readme and package doc. Fixes #133.
Markus Wüstenberg markus@maragu.dk
Thu, 11 May 2023 10:06:23 +0200
2 files changed, 6 insertions(+), 4 deletions(-)
jump to
M README.md → README.md
@@ -25,14 +25,16 @@ - Type safety - Auto-completion - Nice formatting with `gofmt` - Simple API that's easy to learn and use (you know most already if you know HTML) +- Useful helpers like `Text` and `Textf` that insert HTML-escaped text, `Map` for mapping data to components, + and `If` for conditional rendering. - No external dependencies ## Usage Get the library using `go get`: -```shell script -go get -u github.com/maragudk/gomponents +```shell +go get github.com/maragudk/gomponents ``` The preferred way to use gomponents is with so-called dot-imports (note the dot before the `gomponents/html` import),
M gomponents.go → gomponents.go
@@ -4,8 +4,8 @@ // The primary interface is a Node. It describes a function Render, which should render the Node // to the given writer as a string. // // All DOM elements and attributes can be created by using the El and Attr functions. -// The functions Text, Textf, Raw, and Rawf can be used to create text nodes. -// See also helper functions Group, Map, and If. +// The functions Text, Textf, Raw, and Rawf can be used to create text nodes, either HTML-escaped or unescaped. +// See also helper functions Group, Map, and If for mapping data to Nodes and inserting them conditionally. // // For basic HTML elements and attributes, see the package html. // For higher-level HTML components, see the package components.