hugo/content/en/variables/files.md
Bjørn Erik Pedersen a8e9fc699a Squashed 'docs/' changes from 4eb10c1a9..b8b20e9a2
b8b20e9a2 Update index.md
f33994fe6 Remove files.Extension (duplicate of files.Ext)
948d6d69d layouts: Use .File.Path
d3050b78c Document .Page.BundleType (#1620)
8a033918f Image filters: ensure Grayscale is a level-2 heading
98537018f Document .Publish method for global resources
963ddc994 docs: add a link to the mailmap documentation
915f858dc Fix release notes version
58093dafe Update index.md
8008ba1e1 Release 0.91.2
d1788dae8 Merge branch 'tempv0.91.2'
af2970180 Revert "config/security: Add HOME to default exec env var whitelist"
2648d3088 netlify: Hugo 0.91.1
d0801599c Merge branch 'tempv0.91.1'
b343bfd7a config/security: Add HOME to default exec env var whitelist
03fbb403f Update data-templates.md
2f608055f Correct GetRemote docs and examples
4e942166a Update 2021-12-17-no-more-releasenotes.md
dbf9514fd Update security.toml
2c38aa356 Update index.md
562ad8e96 Add timeZone
4bc482152 Update introduction.md
1eb66c758 news: Add a note about the placement of release notes
b2a293abb Remove the default archetype template
f9837793c netlify: Hugo 0.91.0
467256ad5 docs: Regen docs helper
68554cf77 Add some basic security policies with sensible defaults

git-subtree-dir: docs
git-subtree-split: b8b20e9a257dca8e53ca9e5f314cf54b18702a37
2022-01-12 08:15:10 +01:00

1.6 KiB

title linktitle description date publishdate lastmod categories keywords draft menu weight sections_weight aliases toc
File Variables You can access filesystem-related data for a content file in the `.File` variable. 2017-02-01 2017-02-01 2017-02-01
variables and params
files
false
docs
parent weight
variables 40
40 40
/variables/file-variables/
false

{{% note "Rendering Local Files" %}} For information on creating shortcodes and templates that tap into Hugo's file-related feature set, see Local File Templates. {{% /note %}}

The .File object contains the following fields:

.File.Path
the original relative path of the page, relative to the content dir (e.g., posts/foo.en.md)
.File.LogicalName
the name of the content file that represents a page (e.g., foo.en.md)
.File.TranslationBaseName
the filename without extension or optional language identifier (e.g., foo)
.File.ContentBaseName
is a either TranslationBaseName or name of containing folder if file is a leaf bundle.
.File.BaseFileName
the filename without extension (e.g., foo.en)
.File.Ext
the file extension of the content file (e.g., md).
.File.Lang
the language associated with the given file if Hugo's Multilingual features are enabled (e.g., en)
.File.Dir
given the path content/posts/dir1/dir2/, the relative directory path of the content file will be returned (e.g., posts/dir1/dir2/). Note that the path separator (\ or /) could be dependent on the operating system.
.File.UniqueID
the MD5-checksum of the content file's path.