Documentation ¶
Overview ¶
Package urls provides template functions to deal with URLs.
Index ¶
- type Namespace
- func (ns *Namespace) AbsLangURL(s any) (template.HTML, error)
- func (ns *Namespace) AbsURL(s any) (template.HTML, error)
- func (ns *Namespace) Anchorize(s any) (string, error)
- func (ns *Namespace) JoinPath(elements ...any) (string, error)
- func (ns *Namespace) Parse(rawurl any) (*url.URL, error)
- func (ns *Namespace) Ref(p any, args any) (template.HTML, error)
- func (ns *Namespace) RelLangURL(s any) (template.HTML, error)
- func (ns *Namespace) RelRef(p any, args any) (template.HTML, error)
- func (ns *Namespace) RelURL(s any) (template.HTML, error)
- func (ns *Namespace) URLize(s any) (string, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Namespace ¶
type Namespace struct {
// contains filtered or unexported fields
}
Namespace provides template functions for the "urls" namespace.
func (*Namespace) AbsLangURL ¶
AbsLangURL the string s and converts it to an absolute URL according to a page's position in the project directory structure and the current language.
func (*Namespace) Anchorize ¶ added in v0.40.1
Anchorize creates sanitized anchor name version of the string s that is compatible with how your configured markdown renderer does it.
func (*Namespace) JoinPath ¶ added in v0.112.0
JoinPath joins the provided elements into a URL string and cleans the result of any ./ or ../ elements. If the argument list is empty, JoinPath returns an empty string.
func (*Namespace) Parse ¶ added in v0.30.1
Parse parses rawurl into a URL structure. The rawurl may be relative or absolute.
func (*Namespace) RelLangURL ¶
RelLangURL takes the string s and prepends the relative path according to a page's position in the project directory structure and the current language.
func (*Namespace) RelRef ¶
RelRef returns the relative URL path to a given content item from Page p.