https://v0-122-0--gohugoio.netlify.app/methods/site/Recent content in Site methods on HugoHugo -- gohugo.ioenhttps://v0-122-0--gohugoio.netlify.app/methods/site/allpages/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/allpages/This method returns all page kinds in all languages. That includes the home page, section pages, taxonomy pages, term pages, and regular pages. In most cases you should use the RegularPages method instead. {{ range .Site.AllPages }} <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> {{ end }}https://v0-122-0--gohugoio.netlify.app/methods/site/baseurl/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/baseurl/Site configuration: hugo. yaml   toml   json   baseURL: https://example.org/docs/ baseURL = 'https://example.org/docs/' { "baseURL": "https://example.org/docs/" } Template: {{ .Site.BaseURL }} → https://example.org/docs/ There is almost never a good reason to use this method in your templates. Its usage tends to be fragile due to misconfiguration. Use the absURL, absLangURL, relURL, or relLangURL functions instead.https://v0-122-0--gohugoio.netlify.app/methods/site/builddrafts/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/builddrafts/By default, draft pages are not published when building a site. You can change this behavior with a command line flag: hugo --buildDrafts Or by setting buildDrafts to true in your site configuration: hugo. yaml   toml   json   buildDrafts: true buildDrafts = true { "buildDrafts": true } Use the BuildDrafts method on a Site object to determine the current configuration: {{ .Site.BuildDrafts }} → truehttps://v0-122-0--gohugoio.netlify.app/methods/site/config/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/config/The Config method on a Site object provides access to a subset of the site configuration, specifically the services and privacy keys. Services These are the default service settings, typically used by Hugo’s built-in templates and shortcodes. hugo. yaml   toml   json   services: disqus: shortname: "" googleAnalytics: id: "" instagram: accessToken: "" disableInlineCSS: false rss: limit: -1 twitter: disableInlineCSS: false [services] [services.disqus] shortname = '' [services.googleAnalytics] id = '' [services.https://v0-122-0--gohugoio.netlify.app/methods/site/copyright/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/copyright/Site configuration: hugo. yaml   toml   json   copyright: © 2023 ABC Widgets, Inc. copyright = '© 2023 ABC Widgets, Inc.' { "copyright": "© 2023 ABC Widgets, Inc." } Template: {{ .Site.Copyright }} → © 2023 ABC Widgets, Inc.https://v0-122-0--gohugoio.netlify.app/methods/site/data/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/data/Use the Data method on a Site object to access data within the data directory, or within any directory mounted to the data directory. Supported data formats include JSON, TOML, YAML, and XML. Although Hugo can unmarshal CSV files with the transform.Unmarshal function, do not place CSV files in the data directory. You cannot access data within CSV files using this method. Consider this data directory: data/ ├── books/ │ ├── fiction.https://v0-122-0--gohugoio.netlify.app/methods/site/disqusshortname/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/disqusshortname/Deprecated in v0.120.0. Use Site.Config.Services.Disqus.Shortname instead.https://v0-122-0--gohugoio.netlify.app/methods/site/getpage/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/getpage/The GetPage method is also available on Page objects, allowing you to specify a path relative to the current page. See details. When using the GetPage method on a Site object, specify a path relative to the content directory. If Hugo cannot resolve the path to a page, the method returns nil. Consider this content structure: content/ ├── works/ │ ├── paintings/ │ │ ├── _index.md │ │ ├── starry-night.md │ │ └── the-mona-lisa.https://v0-122-0--gohugoio.netlify.app/methods/site/googleanalytics/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/googleanalytics/Deprecated in v0.120.0. Use Site.Config.Services.GoogleAnalytics.ID instead.https://v0-122-0--gohugoio.netlify.app/methods/site/home/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/home/This method is useful for obtaining a link to the home page. Site configuration: hugo. yaml   toml   json   baseURL: https://example.org/docs/ baseURL = 'https://example.org/docs/' { "baseURL": "https://example.org/docs/" } Template: {{ .Site.Home.Permalink }} → https://example.org/docs/ {{ .Site.Home.RelPermalink }} → /docs/https://v0-122-0--gohugoio.netlify.app/methods/site/isdevelopment/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/isdevelopment/ Deprecated in v0.120.0. Use hugo.IsDevelopment instead. {{ .Site.IsDevelopment }} → true/falsehttps://v0-122-0--gohugoio.netlify.app/methods/site/ismultilingual/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/ismultilingual/Site configuration: hugo. yaml   toml   json   defaultContentLanguage: de defaultContentLanguageInSubdir: true languages: de: languageCode: de-DE languageName: Deutsch title: Projekt Dokumentation weight: 1 en: languageCode: en-US languageName: English title: Project Documentation weight: 2 defaultContentLanguage = 'de' defaultContentLanguageInSubdir = true [languages] [languages.de] languageCode = 'de-DE' languageName = 'Deutsch' title = 'Projekt Dokumentation' weight = 1 [languages.en] languageCode = 'en-US' languageName = 'English' title = 'Project Documentation' weight = 2 { "defaultContentLanguage": "de", "defaultContentLanguageInSubdir": true, "languages": { "de": { "languageCode": "de-DE", "languageName": "Deutsch", "title": "Projekt Dokumentation", "weight": 1 }, "en": { "languageCode": "en-US", "languageName": "English", "title": "Project Documentation", "weight": 2 } } } Template:https://v0-122-0--gohugoio.netlify.app/methods/site/isserver/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/isserver/ Deprecated in v0.120.0. Use hugo.IsServer instead. {{ .Site.IsServer }} → true/falsehttps://v0-122-0--gohugoio.netlify.app/methods/site/language/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/language/The Language method on a Site object returns the language object for the given site. The language object points to the language definition in the site configuration. You can also use the Language method on a Page object. See details. Methods The examples below assume the following in your site configuration: hugo. yaml   toml   json   languages: de: languageCode: de-DE languageDirection: ltr languageName: Deutsch weight: 1 [languages] [languages.de] languageCode = 'de-DE' languageDirection = 'ltr' languageName = 'Deutsch' weight = 1 { "languages": { "de": { "languageCode": "de-DE", "languageDirection": "ltr", "languageName": "Deutsch", "weight": 1 } } } Lang (string) The language tag as defined by RFC 5646.https://v0-122-0--gohugoio.netlify.app/methods/site/languageprefix/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/languageprefix/Consider this site configuration: hugo. yaml   toml   json   defaultContentLanguage: de defaultContentLanguageInSubdir: false languages: de: languageCode: de-DE languageDirection: ltr languageName: Deutsch title: Projekt Dokumentation weight: 1 en: languageCode: en-US languageDirection: ltr languageName: English title: Project Documentation weight: 2 defaultContentLanguage = 'de' defaultContentLanguageInSubdir = false [languages] [languages.de] languageCode = 'de-DE' languageDirection = 'ltr' languageName = 'Deutsch' title = 'Projekt Dokumentation' weight = 1 [languages.en] languageCode = 'en-US' languageDirection = 'ltr' languageName = 'English' title = 'Project Documentation' weight = 2 { "defaultContentLanguage": "de", "defaultContentLanguageInSubdir": false, "languages": { "de": { "languageCode": "de-DE", "languageDirection": "ltr", "languageName": "Deutsch", "title": "Projekt Dokumentation", "weight": 1 }, "en": { "languageCode": "en-US", "languageDirection": "ltr", "languageName": "English", "title": "Project Documentation", "weight": 2 } } } When visiting the German language site:https://v0-122-0--gohugoio.netlify.app/methods/site/languages/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/languages/The Languages method on a Site object returns a collection of language objects for all sites, ordered by language weight. Each language object points to its language definition in the site configuration. To view the data structure: <pre>{{ jsonify (dict "indent" " ") .Site.Languages }}</pre> With this site configuration: hugo. yaml   toml   json   defaultContentLanguage: de defaultContentLanguageInSubdir: false languages: de: languageCode: de-DE languageDirection: ltr languageName: Deutsch title: Projekt Dokumentation weight: 1 en: languageCode: en-US languageDirection: ltr languageName: English title: Project Documentation weight: 2 defaultContentLanguage = 'de' defaultContentLanguageInSubdir = false [languages] [languages.https://v0-122-0--gohugoio.netlify.app/methods/site/lastchange/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/lastchange/The LastChange method on a Site object returns a time.Time value. Use this with time functions and methods. For example: {{ .Site.LastChange | time.Format ":date_long" }} → October 16, 2023https://v0-122-0--gohugoio.netlify.app/methods/site/mainsections/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/mainsections/Site configuration: hugo. yaml   toml   json   params: mainSections: - books - films [params] mainSections = ['books', 'films'] { "params": { "mainSections": [ "books", "films" ] } } Template: {{ .Site.MainSections }} → [books films] If params.mainSections is not defined in the site configuration, this method returns a slice with one element—the top level section with the most pages. With this content structure, the “films” section has the most pages:https://v0-122-0--gohugoio.netlify.app/methods/site/menus/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/menus/The Menus method on a Site object returns a collection of menus, where each menu contains one or more entries, either flat or nested. Each entry points to a page within the site, or to an external resource. Menus can be defined and localized in several ways. Please see the menus section for a complete explanation and examples. A site can have multiple menus. For example, a main menu and a footer menu:https://v0-122-0--gohugoio.netlify.app/methods/site/pages/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/pages/This method returns all page kinds in the current language. That includes the home page, section pages, taxonomy pages, term pages, and regular pages. In most cases you should use the RegularPages method instead. {{ range .Site.Pages }} <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> {{ end }}https://v0-122-0--gohugoio.netlify.app/methods/site/param/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/param/The Param method on a Site object is a convenience method to return the value of a user-defined parameter in the site configuration. hugo. yaml   toml   json   params: display_toc: true [params] display_toc = true { "params": { "display_toc": true } } {{ .Site.Param "display_toc" }} → true The above is equivalent to either of these: {{ .Site.Params.display_toc }} {{ index .Site.Params "display_toc" }}https://v0-122-0--gohugoio.netlify.app/methods/site/params/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/params/With this site configuration: hugo. yaml   toml   json   params: author: email: jsmith@example.org name: John Smith copyright-year: "2023" layouts: rfc_1123: Mon, 02 Jan 2006 15:04:05 MST rfc_3339: "2006-01-02T15:04:05-07:00" subtitle: The Best Widgets on Earth [params] copyright-year = '2023' subtitle = 'The Best Widgets on Earth' [params.author] email = 'jsmith@example.org' name = 'John Smith' [params.layouts] rfc_1123 = 'Mon, 02 Jan 2006 15:04:05 MST' rfc_3339 = '2006-01-02T15:04:05-07:00' { "params": { "author": { "email": "jsmith@example.https://v0-122-0--gohugoio.netlify.app/methods/site/regularpages/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/regularpages/{{ range .Site.RegularPages }} <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> {{ end }} By default, Hugo sorts page collections by: The page weight as defined in front matter The page date as defined in front matter The page linkTitle as defined in front matter The file path If the linkTitle is not defined, Hugo evaluates the title instead. To change the sort order, use any of the Pages sorting methods. For example:https://v0-122-0--gohugoio.netlify.app/methods/site/sections/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/sections/Given this content structure: content/ ├── books/ │ ├── book-1.md │ └── book-2.md ├── films/ │ ├── film-1.md │ └── film-2.md └── _index.md This template: {{ range .Site.Sections }} <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> {{ end }} Is rendered to: <h2><a href="/books/">Books</a></h2> <h2><a href="/films/">Films</a></h2>https://v0-122-0--gohugoio.netlify.app/methods/site/sites/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/sites/With this site configuration: hugo. yaml   toml   json   defaultContentLanguage: de defaultContentLanguageInSubdir: false languages: de: languageCode: de-DE languageDirection: ltr languageName: Deutsch title: Projekt Dokumentation weight: 1 en: languageCode: en-US languageDirection: ltr languageName: English title: Project Documentation weight: 2 defaultContentLanguage = 'de' defaultContentLanguageInSubdir = false [languages] [languages.de] languageCode = 'de-DE' languageDirection = 'ltr' languageName = 'Deutsch' title = 'Projekt Dokumentation' weight = 1 [languages.en] languageCode = 'en-US' languageDirection = 'ltr' languageName = 'English' title = 'Project Documentation' weight = 2 { "defaultContentLanguage": "de", "defaultContentLanguageInSubdir": false, "languages": { "de": { "languageCode": "de-DE", "languageDirection": "ltr", "languageName": "Deutsch", "title": "Projekt Dokumentation", "weight": 1 }, "en": { "languageCode": "en-US", "languageDirection": "ltr", "languageName": "English", "title": "Project Documentation", "weight": 2 } } } This template:https://v0-122-0--gohugoio.netlify.app/methods/site/taxonomies/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/taxonomies/Conceptually, the Taxonomies method on a Site object returns a data structure such as: yaml   toml   json   taxonomy a: - term 1: - page 1 - page 2 - term 2: - page 1 taxonomy b: - term 1: - page 2 - term 2: - page 1 - page 2 [['taxonomy a']] 'term 1' = ['page 1', 'page 2'] [['taxonomy a']] 'term 2' = ['page 1'] [['taxonomy b']] 'term 1' = ['page 2'] [['taxonomy b']] 'term 2' = ['page 1', 'page 2'] { "taxonomy a": [ { "term 1": [ "page 1", "page 2" ] }, { "term 2": [ "page 1" ] } ], "taxonomy b": [ { "term 1": [ "page 2" ] }, { "term 2": [ "page 1", "page 2" ] } ] } For example, on a book review site you might create two taxonomies; one for genres and another for authors.https://v0-122-0--gohugoio.netlify.app/methods/site/title/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/methods/site/title/Site configuration: hugo. yaml   toml   json   title: My Documentation Site title = 'My Documentation Site' { "title": "My Documentation Site" } Template: {{ .Site.Title }} → My Documentation Site