kinds

package

v0.125.5 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 2 Imported by: 3

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 ¶

Constants
Variables
func GetKindAny(s string) string
func GetKindMain(s string) string
func IsBranch(kind string) bool
func IsDeprecatedAndReplacedWith(s string) string

Constants ¶

View Source

const (
	KindPage = "page"

	KindHome    = "home"
	KindSection = "section"

	// Note that before Hugo 0.73 these were confusingly named
	// taxonomy (now: term)
	// taxonomyTerm (now: taxonomy)
	KindTaxonomy = "taxonomy"
	KindTerm     = "term"

	// The following are (currently) temporary nodes,
	// i.e. nodes we create just to render in isolation.
	KindRSS          = "rss"
	KindSitemap      = "sitemap"
	KindSitemapIndex = "sitemapindex"
	KindRobotsTXT    = "robotstxt"
	KindStatus404    = "404"
)

Variables ¶

View Source

var (
	// This is all the kinds we can expect to find in .Site.Pages.
	AllKindsInPages []string
	// This is all the kinds, including the temporary ones.
	AllKinds []string
)

Functions ¶

func GetKindAny ¶

func GetKindAny(s string) string

GetKindAny gets the page kind given a string, empty if not found.

func GetKindMain ¶

func GetKindMain(s string) string

GetKindMain gets the page kind given a string, empty if not found. Note that this will not return any temporary kinds (e.g. robotstxt).

func IsBranch ¶ added in v0.123.0

func IsBranch(kind string) bool

IsBranch returns whether the given kind is a branch node.

func IsDeprecatedAndReplacedWith ¶

func IsDeprecatedAndReplacedWith(s string) string

IsDeprecatedAndReplacedWith returns the new kind if the given kind is deprecated.

Types ¶

This section is empty.

Source Files ¶

View all Source files

kinds.go

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