元数据扩展

元数据扩展是Quarto扩展,提供可以以可重用的方式合并到现有Quarto配置中的元数据(YAML对象)。

Important

目前,元数据扩展仅合并项目级别的元数据。未来将解除这一限制。

快速开始

这里我们将描述如何创建一个简单的元数据扩展。我们将使用quarto create命令来完成这个任务。如果你使用的是VS Code或RStudio,你应该在它们各自的集成终端窗格中执行quarto create

要开始,请在你希望创建过滤器扩展的父目录中执行quarto create extension metadata

终端
$ quarto create extension metadata
 ? 扩展名称 › my-prerender-scripts

如上所示,系统会提示你输入扩展名称。输入my-prerender-scripts并按下回车——过滤器扩展随即创建:

? 扩展名称 › my-prerender-scripts
 /Users/cscheid/Desktop/my-prerender-scripts 创建扩展:
  - 创建了 README.md
  - 创建了 _extensions/my-prerender-scripts/_extension.yml
  - 创建了 .gitignore
? 打开方式
 vscode
  rstudio
  (不打开)

如果你在VS Code或RStudio中运行,将会打开一个包含扩展项目的新窗口。

元数据扩展的内容

以下是_extensions/my-prerender-scripts/目录中文件的内容:

_extensions/my-prerender-scripts/_extension.yml
title: My-prerender-scripts
author: Carlos Scheidegger
version: 1.0.0
quarto-required: ">=99.9.0"
contributes:
  metadata:
    project:
      # 你的项目元数据放在这里

元数据扩展的工作原理

project键下,你添加的任何YAML都会自动合并到使用此扩展的任何项目中。 这与自定义项目扩展的行为不同。 使用元数据扩展的Quarto项目不需要更改其项目类型即可合并元数据。

Note

如上所述,元数据扩展仅在project键下合并项目级别的元数据。未来将解除这一限制。