跳至正文

终端 > Warp Drive 概览

Warp Drive 笔记本

在 ChatGPT 中打开 ↗
向 ChatGPT 询问关于此页面的内容
在 Claude 中打开 ↗
向 Claude 询问关于此页面的内容
已复制!

保存交互式手册以简化入职和开发流程。

笔记本是 Warp Drive 中可交互、可运行的文档,它将 Markdown 文本与可执行的 Shell 命令块相结合。你可以使用它们来编写入职手册、调试运维文档,以及开发工作流,让团队成员能够直接在终端中搜索、共享和执行这些内容。

笔记本是可运行的文档,由 Markdown 文本、列表元素、代码块以及可以在终端会话中自动执行的可运行 Shell 代码片段组成。笔记本可以通过 命令面板 进行搜索和访问,这样你无需离开终端即可访问并运行你的文档。你还可以随时以 .md 格式导出笔记本。

你可以从 Warp 中的多个入口点创建新的笔记本

  • 从 Warp Drive 中,点击 + > 新建笔记本
  • 命令面板,创建一个新的团队或个人笔记本。

任何这些入口点都会打开笔记本编辑器,在这里你可以

  • 为笔记本命名。
  • 开始添加文本和代码元素。

Editing a Notebook

编辑笔记本。

笔记本元素(文本、代码、列表项)可以通过多种方式添加

  • 使用相应的 Markdown 快捷键(例如 ### 表示三级标题)。
  • 输入 /,将打开一个受支持元素的选项菜单。
  • 将鼠标悬停在某一行上,点击出现的 + 图标,并从受支持元素的菜单中进行选择。

Markdown element types

笔记本编辑器中可用的 Markdown 元素类型。

现有笔记本元素可以通过多种方式设置样式

  • 选择现有元素,并从悬停菜单中选择文本装饰(如加粗、斜体或行内代码)。
  • 使用 Markdown 语法设置文本样式,如 **粗体** 或 *斜体*。
  • 选择现有元素,并通过下拉元素菜单更改元素的整体类型。
Styling menu

命令块和代码块具有多种独特属性,如语法高亮和快速操作,使基于代码的文档处理变得简单。你可以通过以下方式创建代码块或命令块

  • 从新元素菜单中选择“命令 (Command)”或“代码 (Code)”
  • 输入 ```(三个反引号)

插入代码块后,你可以从众多选项中选择块底部的语言,这将应用相应的语法高亮(如果未找到你的语言,则默认使用 Code)。所有代码块和命令块都将应用语法高亮,并提供一个快速复制按钮以便轻松访问。

Example code block

笔记本中带有语法高亮的代码块。

如果你插入一个命令块或将语言指定为“Shell”,Warp 将提供额外的功能来简化终端工作。

开发者可以通过以下方式执行 Shell 命令块

  • 使用块底部的插入按钮
  • 在选中该块时按下 CMD-ENTER(会出现蓝色高亮)

命令文本将被插入到开发者活动的终端会话中,如果当前没有活动的会话,则会启动一个新会话。

Run option for command block

笔记本中命令块上的运行按钮。

命令块接受与 工作流 相同格式的参数。要向你的命令块添加参数,请使用 {{双大括号}} 来指定你的参数项。

Command block with parameters

一个带有可编辑参数的命令块。

命令块也支持键盘导航。有两种方式进入键盘导航模式

  • 点击 Shell 块。
  • 按下 CMD-UPCMD-DOWN

一旦选中某个命令块,按下 CMD-ENTER 将其插入到终端输入中。你还可以使用 UP, DOWN, CMD-UPCMD-DOWN 在命令块之间导航。在笔记本获得焦点时,按下 CMD-L 可以将焦点切换回终端而不插入命令。

如果你有现有的 工作流 想要插入笔记本中,而不是复制其内容,你可以从新元素菜单中选择“嵌入式工作流 (Embedded Workflow)”,然后从可用的工作流中进行选择。一旦嵌入到笔记本中,该工作流将像普通命令块一样可执行。要编辑嵌入式工作流的内容,你需要编辑源工作流,可以通过在 命令面板 中搜索标题来找到它。

Embedding an existing workflow in a notebook.

在笔记本中嵌入现有工作流。

如果笔记本与团队共享,所有团队成员都将有权编辑该笔记本,更新将立即对所有成员同步。

View mode example

以查看模式显示的笔记本。

请参阅我们的 Warp Drive 导入和导出 说明。