urls

package

v0.125.0 Latest Latest Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 8

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gohugoio/hugo

Links

Open Source Insights

Documentation ¶

Index ¶

type BaseURL
- func NewBaseURLFromString(b string) (BaseURL, error)
type RefLinker

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BaseURL ¶ added in v0.112.0

type BaseURL struct {
	WithPath                string
	WithPathNoTrailingSlash string
	WithoutPath             string
	BasePath                string
	BasePathNoTrailingSlash string
	// contains filtered or unexported fields
}

A BaseURL in Hugo is normally on the form scheme://path, but the form scheme: is also valid (mailto:hugo@rules.com).

func NewBaseURLFromString ¶ added in v0.112.0

func NewBaseURLFromString(b string) (BaseURL, error)

func (BaseURL) HostURL ¶ added in v0.112.0

func (b BaseURL) HostURL() string

HostURL returns the URL to the host root without any path elements.

func (BaseURL) Path ¶ added in v0.112.0

func (b BaseURL) Path() string

func (BaseURL) Port ¶ added in v0.112.0

func (b BaseURL) Port() int

func (BaseURL) String ¶ added in v0.112.0

func (b BaseURL) String() string

func (BaseURL) URL ¶ added in v0.112.0

func (b BaseURL) URL() *url.URL

URL returns a copy of the internal URL. The copy can be safely used and modified.

func (BaseURL) WithPort ¶ added in v0.112.0

func (b BaseURL) WithPort(port int) (BaseURL, error)

func (BaseURL) WithProtocol ¶ added in v0.112.0

func (b BaseURL) WithProtocol(protocol string) (BaseURL, error)

WithProtocol returns the BaseURL prefixed with the given protocol. The Protocol is normally of the form "scheme://", i.e. "webcal://".

type RefLinker ¶

type RefLinker interface {
	Ref(args map[string]any) (string, error)
	RelRef(args map[string]any) (string, error)
}

RefLinker is implemented by those who support reference linking. args must contain a path, but can also point to the target language or output format.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL