VS Code 笔记本编辑器

除了将 Quarto 文档作为纯文本 .qmd 文件进行编辑外,您还可以使用 VS Code 笔记本编辑器来创作由 Quarto 渲染的 .ipynb 笔记本。在本文中,我们将回顾使用 Quarto 编辑 .ipynb 笔记本的基础知识。

渲染和预览

使用 Quarto 编辑笔记本的基本工作流程与编辑 .qmd 文件的工作流程相同。编辑文件后,执行 Quarto: Preview 命令(您也可以使用 Ctrl+Shift+K 键盘快捷键)。您将看到发布页面的预览与笔记本并排显示:

在您首次执行 Quarto: Preview 后,每次保存笔记本时,预览都会自动更新。

YAML 前言

笔记本的第一个单元格应为包含文档标题、作者以及您需要指定的任何其他选项的 Raw 单元格。请注意,您可以使用单元格右下角的单元格类型菜单将单元格类型切换为 Raw

在 VSCode 中打开的 ipynb 文件的顶部部分。有一个包含 yaml 前言的 Raw 单元格。

在此示例中,我们指定希望代码默认折叠显示。有许多 YAML 选项可以控制文档渲染的许多其他方面。有关更多详细信息,请参阅关于 创作输出格式 的文档。

Markdown 单元格

以下是 Markdown 单元格的底层代码:

包含 Markdown 单元格的 ipynb 文档片段。该单元格包含一些用 Markdown 编写的文本。

请注意,Markdown 中包含了一个 Quarto 交叉引用(@fig-polar)。任何有效的 Pandoc Markdown 语法都可以包含在 Markdown 单元格中。

输出选项

Quarto 使用带有特殊前缀(#|)的行首注释来表示单元格选项。在这里,我们指定了 labelfig-cap 选项,以便可以交叉引用从该单元格生成的图表。

包含代码单元格的 JupyterLab 文档片段。在代码之前,单元格顶部是 Quarto 块选项 '#| label: fig-polar' 和 '#| fig-cap: A line plot on a polar axis.'

请注意,选项必须出现在单元格的最开始。与文档前言一样,选项名称/值使用 YAML 语法。

有许多可用的输出选项,包括可选地隐藏代码、警告和/或输出的选项。有关更多详细信息,请参阅关于 输出选项 的文档。

单元格执行

请注意,当渲染一个 .ipynb 文件时,Quarto 默认不会 执行笔记本中的单元格(假设你在编辑笔记本时已经执行过这些单元格)。如果你想执行这些单元格,可以在渲染时传递 --execute 标志:

Terminal
quarto render notebook.ipynb --execute

你也可以在笔记本的 YAML 前文中指定这种行为:

---
title: "My Notebook"
execute: 
  enabled: true
---

还有许多其他可用的执行选项(例如控制缓存、优化内核启动时间等)。在 执行选项 中了解更多关于这些选项的信息。

转换笔记本

您可以使用 quarto convert 命令在 .ipynb.qmd 笔记本表示之间进行转换。例如:

Terminal
quarto convert basics-jupyter.ipynb
quarto convert basics-jupyter.qmd

有关转换笔记本的更多详细信息,请参阅 quarto convert help