File Variables

Variables

.File.Path

(string) The file path, relative to the content directory.

.File.Dir

(string) The file path, excluding the file name, relative to the content directory.

.File.LogicalName

(string) The file name.

.File.BaseFileName

(string) The file name, excluding the extension.

.File.TranslationBaseName

(string) The file name, excluding the extension and language identifier.

.File.Ext

(string) The file extension.

.File.Lang

(string) The language associated with the given file.

.File.ContentBaseName

(string) If the page is a branch or leaf bundle, the name of the containing directory, else the .TranslationBaseName.

.File.Filename

(string) The absolute file path.

.File.UniqueID

(string) The MD5 hash of .File.Path.

Examples

content/
├── news/
│   ├── b/
│   │   ├── index.de.md   <-- leaf bundle
│   │   └── index.en.md   <-- leaf bundle
│   ├── a.de.md           <-- regular content
│   ├── a.en.md           <-- regular content
│   ├── _index.de.md      <-- branch bundle
│   └── _index.en.md      <-- branch bundle
├── _index.de.md
└── _index.en.md

With the content structure above, the .File objects for the English pages contain the following properties:

Defensive coding

Some of the pages on a site may not be backed by a file. For example:

• Top level section pages
• Taxonomy pages
• Term pages

Without a backing file, Hugo will throw a warning if you attempt to access a .File property. For example:

WARN .File.ContentBaseName on zero object. Wrap it in if or with...

To code defensively:

{{ with .File }}
  {{ .ContentBaseName }}
{{ end }}