HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
方法 页面方法

文件

对于由文件支持的页面,返回给定页面的文件信息。

Syntax

PAGE.File

Returns

hugolib.fileInfo

默认情况下,并非所有页面都由文件支持,包括顶级 章节 页面、 分类 页面和 术语 页面。根据定义,当文件不存在时,您无法检索文件信息。

要使用文件支持上述页面之一,请在相应的目录中创建一个 _index.md 文件。例如:

content/
└── books/
    ├── _index.md  <-- 顶级章节页面
    ├── book-1.md
    └── book-2.md

如以下示例所示,通过验证文件是否存在来进行防御性编码。

方法

Path 、 Dir 和 Filename 中的路径分隔符(斜杠或反斜杠)取决于操作系统。

BaseFileName

(string) 文件名,不包括扩展名。

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

(string) 如果页面是分支或叶子捆绑包,则为包含目录的名称,否则为 TranslationBaseName 。

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

(string) 文件路径,不包括文件名,相对于 content 目录。

{{ with .File }}
  {{ .Dir }}
{{ end }}
Ext

(string) 文件扩展名。

{{ with .File }}
  {{ .Ext }}
{{ end }}
Filename

(string) 绝对文件路径。

{{ with .File }}
  {{ .Filename }}
{{ end }}
IsContentAdapter
New in v0.126.0

(bool) 报告文件是否是 内容适配器 。

{{ with .File }}
  {{ .IsContentAdapter }}
{{ end }}
LogicalName

(string) 文件名。

{{ with .File }}
  {{ .LogicalName }}
{{ end }}
Path

(string) 文件路径,相对于 content 目录。

{{ with .File }}
  {{ .Path }}
{{ end }}
Section

(string) 文件所在的顶级章节的名称。

{{ with .File }}
  {{ .Section }}
{{ end }}
TranslationBaseName

(string) 文件名,不包括扩展名和语言标识符。

{{ with .File }}
  {{ .TranslationBaseName }}
{{ end }}
UniqueID

(string) .File.Path 的 MD5 哈希值。

{{ with .File }}
  {{ .UniqueID }}
{{ end }}

示例

考虑多语言项目中的以下内容结构:

content/
├── news/
│   ├── b/
│   │   ├── index.de.md   <-- 叶子捆绑包
│   │   └── index.en.md   <-- 叶子捆绑包
│   ├── a.de.md           <-- 常规内容
│   ├── a.en.md           <-- 常规内容
│   ├── _index.de.md      <-- 分支捆绑包
│   └── _index.en.md      <-- 分支捆绑包
├── _index.de.md
└── _index.en.md

使用英语站点:

  常规内容 叶子捆绑包 分支捆绑包
BaseFileName a.en index.en _index.en
ContentBaseName a b news
Dir news/ news/b/ news/
Ext md md md
Filename /home/user/… /home/user/… /home/user/…
IsContentAdapter false false false
LogicalName a.en.md index.en.md _index.en.md
Path news/a.en.md news/b/index.en.md news/_index.en.md
Section news news news
TranslationBaseName a index _index
UniqueID 15be14b… 186868f… 7d9159d…

防御性编码

网站上的一些页面可能没有由文件支持。例如:

  • 顶级章节页面
  • 分类页面
  • 术语页面

如果没有支持文件,如果您尝试访问 .File 属性,Hugo 将抛出错误。要进行防御性编码,首先检查文件是否存在:

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

On this page

  • 方法
  • 示例
  • 防御性编码

In this section

  • Bundle类型
  • CodeOwners
  • ContentWithoutSummary
  • ExpiryDate
  • GetPage
  • GetTerms
  • Git信息
  • HasMenuCurrent
  • HasShortcode函数
  • InSection
  • IsAncestor
  • IsDescendant
  • IsHome
  • IsMenuCurrent
  • IsNode
  • IsPage
  • IsSection
  • IsTranslated
  • Lastmod
  • Len
  • LinkTitle
  • NextInSection
  • PAGE.Store
  • Plain 方法
  • PlainWords
  • PrevInSection
  • PublishDate
  • RegularPages
  • RegularPagesRecursive
  • RelPermalink
  • RelRef
  • Render
  • RenderShortcodes
  • RenderString
  • Slug
  • Truncated
  • 上一页
  • 下一个
  • 临时存储区
  • 关键词
  • 内容
  • 分页
  • 分页器
  • 别名
  • 原始内容
  • 参数
  • 参数
  • 备选输出格式
  • 多语言翻译
  • 字数统计
  • 布局
  • 引用
  • 当前章节
  • 所有翻译
  • 摘要
  • 数据
  • 文件
  • 日期
  • 权重
  • 标题
  • 标题过滤
  • 模糊字数统计
  • 永久链接
  • 父级
  • 片段
  • 目录
  • 相等性判断
  • 祖先页面
  • 种类
  • 站点
  • 站点
  • 站点地图
  • 第一节
  • 类型
  • 翻译密钥
  • 节区
  • 草稿
  • 语言
  • 资源
  • 路径
  • 输出格式
  • 部分
  • 阅读时间
  • 页面
  • 页面
  • 页面描述
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护