diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-01-11 17:07:04 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-01-11 20:06:23 +0300 |
| commit | 7396aa945a6ea7720d5dc77414ff02a4cbef7dfa (patch) | |
| tree | 9882f02947ea693da48bc5936ab5ab80314f304c /docs/content/en | |
| parent | d82cef5c53903dc52a353b3bd67d7ee11c55e4a4 (diff) | |
Add hugo.Deps
Fixes #8949
Diffstat (limited to 'docs/content/en')
| -rw-r--r-- | docs/content/en/functions/hugo.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/content/en/functions/hugo.md b/docs/content/en/functions/hugo.md index 6cbb36019..fb20d2717 100644 --- a/docs/content/en/functions/hugo.md +++ b/docs/content/en/functions/hugo.md @@ -49,3 +49,67 @@ hugo.IsProduction {{% 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 %}} + +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). + +Eeach dependency contains: + +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. + +Vendor (bool) +: Whether this dependency is vendored. + +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">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 }}{{ else }}PROJECT{{ 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> +```
\ No newline at end of file |