fes.js/docs/zh/reference/frontmatter.md
2021-01-19 21:13:13 +08:00

2.9 KiB
Raw Blame History

Frontmatter

lang

  • 类型: string

  • 详情:

    页面的语言。

    它将会覆盖站点配置中的 lang 配置项

  • 参考:

title

  • 类型: string

  • 详情:

    页面的标题。

    如果你不在 Frontmatter 中设置 title ,那么页面中第一个一级标题(即 # title)的内容会被当作标题使用。

description

  • 类型: string

  • 详情:

    页面的描述。

    它将会覆盖站点配置中的 description 配置项

  • 参考:

head

  • 类型: HeadConfig[]

  • 详情:

    页面 <head> 标签内添加的额外标签。

  • 示例:

---
head:
  - - meta
    - name: foo
      content: bar
  - - link
    - rel: canonical
      href: foobar
---

渲染为:

<head>
  <meta name="foo" content="bar" />
  <link rel="canonical" href="foobar" />
</head>

date

  • 类型: string

  • 详情:

    页面的创建日期。

    应按照 yyyy-MM-dd 的格式来指定日期,或者遵循 YAML Timestamp Type

permalinkPattern

  • 类型: string

  • 详情:

    为页面生成永久链接的 Pattern 。

    如果 Frontmatter 中设置了 permalink ,那么这个字段则不会生效。

  • 使用:

    Pattern 描述
    :year 创建日期的 年 部分
    :month 创建日期的 月 部分
    :day 创建日期的 日 部分
    :slug 页面文件名的 Slug
    :raw 原始路由路径

    :year, :month:day Pattern 根据如下优先级进行解析:

    • Frontmatter 中的 date 字段。
    • 符合 yyyy-MM-dd-foobar.mdyyyy-MM-foobar.md 日期格式的文件名。
    • 符合 yyyy/MM/dd/foobar.mdyyyy/MM/foobar.md 日期格式的目录名。
    • 默认值 1970-01-01
  • 示例:

    • 情况 1

      页面文件名是 foo-bar.md

      页面 Frontmatter 是:

---
date: 2021-01-03
permalinkPattern: :year/:month/:day/:slug.html
---
那么页面的永久链接将会是 `2021/01/03/foo-bar.html` 。
  • 情况 2

    页面文件名是 2021-01-03-bar-baz.md

    页面 Frontmatter 是:

---
permalinkPattern: :year/:month/:day/:slug.html
---
那么页面的永久链接将会是 `2021/01/03/bar-baz.html` 。

layout

  • 类型: string

  • 详情:

    页面的布局。