github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/extras/gitinfo.md
Cameron Moore d332aa1606 docs: Update GitInfo usage docs
2016-12-15 11:15:15 +01:00

1.1 KiB
Raw Blame History

aliases lastmod date menu next prev title
/doc/gitinfo/
2016-12-11 2016-12-11
main
parent
extras
/extras/livereload /extras/datadrivencontent GitInfo

Hugo provides a way to integrate Git data into your site.

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. Enable the GitInfo feature in Hugo by using --enableGitInfo on the command line or by setting enableGitInfo to true in your site configuration.

The GitInfo Object

The GitInfo object contains the following fields:

AbbreviatedHash
abbreviated commit hash, e.g. 866cbcc
AuthorName
author name, respecting .mailmap
AuthorEmail
author email address, respecting .mailmap
AuthorDate
the author date
Hash
commit hash, e.g. 866cbccdab588b9908887ffd3b4f2667e94090c3
Subject
commit message subject, e.g. tpl: Add custom index function

Performance Considerations

The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size.