diff options
author | Markus Wüstenberg | 2022-05-25 14:36:26 +0200 |
---|---|---|
committer | GitHub | 2022-05-25 14:36:26 +0200 |
commit | c868c525b4c91bd5b2f2b872f3631d4491271191 (patch) | |
tree | 8bef74b7cbdbb1f04f07414f3d340abbde6b870e /gomponents.go | |
parent | 97698614be4f60cd47c872b5275459bcc8f6e14f (diff) | |
download | gomponents-c868c525b4c91bd5b2f2b872f3631d4491271191.tar.lz gomponents-c868c525b4c91bd5b2f2b872f3631d4491271191.tar.zst gomponents-c868c525b4c91bd5b2f2b872f3631d4491271191.zip |
Update package doc to reflect new content (#102)
It hadn't been updated in a while.
Diffstat (limited to 'gomponents.go')
-rw-r--r-- | gomponents.go | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/gomponents.go b/gomponents.go index 5ac6939..e6acf44 100644 --- a/gomponents.go +++ b/gomponents.go @@ -1,10 +1,16 @@ // Package gomponents provides view components in Go, that render to HTML 5. -// The primary interface is a Node, which has a single function Render, which should render -// the Node to a string. Furthermore, NodeFunc is a function which implements the Node interface -// by calling itself on Render. +// +// 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 package also provides a lot of convenience functions for creating elements and attributes -// with the most commonly used parameters. If they don't suffice, a fallback to El and Attr is always possible. +// The functions Text, Textf, and Raw can be used to create text nodes. +// See also helper functions Group, Map, and If. +// +// For basic HTML elements and attributes, see the package html. +// For higher-level HTML components, see the package components. +// For SVG elements and attributes, see the package svg. +// For HTTP helpers, see the package http. package gomponents import ( |