hugo/docs/content/en/methods/page/Sites.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925
2024-01-27 10:48:57 +01:00

69 lines
1.4 KiB
Markdown

---
title: Sites
description: Returns a collection of all Site objects, one for each language, ordered by language weight.
categories: []
keywords: []
action:
related:
- methods/page/Site
returnType: page.Sites
signatures: [PAGE.Sites]
---
This is a convenience method to access `.Site.Sites`.
With this site configuration:
{{< code-toggle file=hugo >}}
defaultContentLanguage = 'de'
defaultContentLanguageInSubdir = false
[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
{{< /code-toggle >}}
This template:
```go-html-template
<ul>
{{ range .Sites }}
<li><a href="{{ .Home.Permalink }}">{{ .Title }}</a></li>
{{ end }}
</ul>
```
Produces a list of links to each home page:
```html
<ul>
<li><a href="https://example.org/de/">Projekt Dokumentation</a></li>
<li><a href="https://example.org/en/">Project Documentation</a></li>
</ul>
```
To render a link to home page of the primary (first) language:
```go-html-template
{{ with .Sites.First }}
<a href="{{ .Home.Permalink }}">{{ .Title }}</a>
{{ end }}
```
This is equivalent to:
```go-html-template
{{ with index .Sites 0 }}
<a href="{{ .Home.Permalink }}">{{ .Title }}</a>
{{ end }}
```