mirror of
https://github.com/gohugoio/hugo.git
synced 2026-09-02 11:42:37 +00:00
Bud Parr
6896947058
* add generic menu declaration * update about section * commands * update content management section * update contribute section * functions * update getting started section * update hosting and deployment section * fix mailing list entry (no menu) * update news section * update Templates section * update tools section * update themes section * troubleshooting * update variables section Fixes rdwatters/hugo-docs-concept#45 See PR rdwatters/hugo-docs-concept#62
56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
---
|
|
title: Git Info Variables
|
|
linktitle: Git Variables
|
|
description:
|
|
date: 2017-03-12
|
|
publishdate: 2017-03-12
|
|
lastmod: 2017-03-12
|
|
categories: [variables and params]
|
|
tags: [git]
|
|
draft: false
|
|
menu:
|
|
main:
|
|
parent: "Variables"
|
|
weight: 70
|
|
weight: 70 #rem
|
|
aliases: [/extras/gitinfo/]
|
|
toc: false
|
|
wip: false
|
|
---
|
|
|
|
Hugo provides a way to integrate Git data into your website.
|
|
|
|
{{% note "`.GitInfo` Performance Considerations" %}}
|
|
Hugo's Git integrations should be fairly performant but *can* increase your build time. This will depend on the size of your Git history.
|
|
{{% /note %}}
|
|
|
|
## `.GitInfo` Prerequisites
|
|
|
|
1. The Hugo site must be in a Git-enabled directory.
|
|
2. The Git executable must be installed and in your system `PATH`.
|
|
3. The `.GitInfo` feature must be enabled in your Hugo project by passing `--enableGitInfo` flag on the command line or by setting `enableGitInfo` to `true` in your [site's configuration file][configuration].
|
|
|
|
## The `.GitInfo` Object
|
|
|
|
The `GitInfo` object contains the following fields:
|
|
|
|
`.AbbreviatedHash`
|
|
: the abbreviated commit hash (e.g., `866cbcc`)
|
|
|
|
`.AuthorName`
|
|
: the author's name, respecting `.mailmap`
|
|
|
|
`.AuthorEmail`
|
|
: the author's email address, respecting `.mailmap`
|
|
|
|
`.AuthorDate`
|
|
: the author date
|
|
|
|
`.Hash`
|
|
: the commit hash (e.g., `866cbccdab588b9908887ffd3b4f2667e94090c3`)
|
|
|
|
`.Subject`
|
|
: commit message subject (e.g., `tpl: Add custom index function`)
|
|
|
|
[configuration]: /getting-started/configuration/
|