2020-02-06 07:02:49 -05:00
---
title: hugo
linktitle: hugo
description: The `hugo` function provides easy access to Hugo-related data.
date: 2019-01-31
publishdate: 2019-01-31
keywords: []
categories: [functions]
menu:
docs:
parent: "functions"
toc:
signature: ["hugo"]
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
draft: false
aliases: []
---
2020-06-16 08:18:51 -04:00
2020-02-06 07:02:49 -05:00
`hugo` returns an instance that contains the following functions:
hugo.Generator
2022-10-14 06:16:53 -04:00
: `<meta>` tag for the version of Hugo that generated the site. `hugo.Generator` outputs a *complete* HTML tag; e.g. `<meta name="generator" content="Hugo 0.63.2">`
2020-02-06 07:02:49 -05:00
hugo.Version
: the current version of the Hugo binary you are using e.g. `0.63.2`
2022-05-30 09:12:41 -04:00
hugo.GoVersion
: returns the version of Go that the Hugo binary was built with. {{< new-in " 0 . 101 . 0 " > }}
2020-02-06 07:02:49 -05:00
hugo.Environment
2020-03-09 15:19:32 -04:00
: the current running environment as defined through the `--environment` cli tag
2020-02-06 07:02:49 -05:00
hugo.CommitHash
: the git commit hash of the current Hugo binary e.g. `0e8bed9ccffba0df554728b46c5bbf6d78ae5247`
hugo.BuildDate
: the compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00`
2021-04-20 14:21:45 -04:00
hugo.IsExtended {{< new-in " 0 . 83 . 0 " > }}
: whether this is the extended Hugo binary.
2020-03-09 15:19:32 -04:00
hugo.IsProduction
: returns true if `hugo.Environment` is set to the production environment
2020-02-06 07:02:49 -05:00
{{% note "Use the Hugo Generator Tag" %}}
We highly recommend using `hugo.Generator` in your website's `<head>` . `hugo.Generator` is included by default in all themes hosted on [themes.gohugo.io ](https://themes.gohugo.io ). The generator tag allows the Hugo team to track the usage and popularity of Hugo.
{{% /note %}}
2022-02-14 06:58:42 -05:00
hugo.Deps
: See [hugo.Deps ](#hugodeps )
## hugo.Deps
{{< new-in " 0 . 92 . 0 " > }}
`hugo.Deps` returns a list of dependencies for a project (either Hugo Modules or local theme components).
2022-03-26 05:04:57 -04:00
Each dependency contains:
2022-02-14 06:58:42 -05:00
Path (string)
: Returns the path to this module. This will either be the module path, e.g. "github.com/gohugoio/myshortcodes", or the path below your /theme folder, e.g. "mytheme".
Version (string)
: The module version.
2022-03-26 05:04:57 -04:00
2022-02-14 06:58:42 -05:00
Vendor (bool)
: Whether this dependency is vendored.
2022-03-26 05:04:57 -04:00
2022-02-14 06:58:42 -05:00
Time (time.Time)
: Time version was created.
Owner
: In the dependency tree, this is the first module that defines this module as a dependency.
Replace (*Dependency)
: Replaced by this dependency.
An example table listing the dependencies:
```html
< h2 > Dependencies< / h2 >
< table class = "table table-dark" >
< thead >
< tr >
< th scope = "col" > #< / th >
< th scope = "col" > Owner< / th >
< th scope = "col" > Path< / th >
< th scope = "col" > Version< / th >
< th scope = "col" > Time< / th >
< th scope = "col" > Vendor< / th >
< / tr >
< / thead >
< tbody >
{{ range $index, $element := hugo.Deps }}
< tr >
< th scope = "row" > {{ add $index 1 }}< / th >
< td > {{ with $element.Owner }}{{.Path }}{{ end }}< / td >
< td >
{{ $element.Path }}
{{ with $element.Replace}}
=> {{ .Path }}
{{ end }}
< / td >
< td > {{ $element.Version }}< / td >
< td > {{ with $element.Time }}{{ . }}{{ end }}< / td >
< td > {{ $element.Vendor }}< / td >
< / tr >
{{ end }}
< / tbody >
< / table >
2022-05-30 09:12:41 -04:00
```