hextra_mirror/exampleSite/content/docs/guide/shortcodes/jupyter.zh-cn.md

title, linktitle, math, sidebar

title	linktitle	math	sidebar
Jupyter Notebook 组件	Jupyter Notebook	true	exclude true

{{< callout >}}实验性功能：通过短代码嵌入 Jupyter Notebook。注意并非所有单元格类型都受支持。{{< /callout >}}

Jupyter Notebook 是 Project Jupyter 推出的语言无关的 HTML 笔记本应用。它允许你创建和分享包含动态代码、数学公式、可视化图表和叙述性文本的文档。

使用方法

使用本地笔记本

要使用 Jupyter Notebook 短代码，你需要在项目中放置一个 Jupyter Notebook 文件。与添加图片到项目类似，你可以将 Jupyter Notebook 放入 assets 文件夹。

{{< filetree/container >}} {{< filetree/folder name="assets" >}} {{< filetree/file name="notebook.ipynb" >}} {{< /filetree/folder >}} {{< filetree/folder name="content" >}} {{< filetree/folder name="docs" >}} {{< filetree/file name="my-page.md" >}} {{< /filetree/folder >}} {{< /filetree/folder >}} {{< /filetree/container >}}

使用 jupyter 短代码将笔记本嵌入页面：

---
title: 我的页面
math: true
---

{{%/* jupyter "notebook.ipynb" */%}}

或者，你可以利用 Hugo 的页面包功能，将 Jupyter Notebook 与 Markdown 文件组织在一起。

{{< filetree/container >}} {{< filetree/folder name="content" >}} {{< filetree/folder name="docs" >}} {{< filetree/folder name="my-page" >}} {{< filetree/file name="index.md" >}} {{< filetree/file name="notebook.ipynb" >}} {{< /filetree/folder >}} {{< /filetree/folder >}} {{< /filetree/folder >}} {{< /filetree/container >}}

---
title: 我的页面
math: true
---

{{%/* jupyter "notebook.ipynb" */%}}

使用远程笔记本

你也可以通过提供笔记本文件的 URL 来使用远程笔记本。例如，要在页面中嵌入 什么是 Jupyter Notebook 笔记本，可以使用以下短代码：

{{%/* jupyter "https://raw.githubusercontent.com/jupyter/notebook/main/docs/source/examples/Notebook/What%20is%20the%20Jupyter%20Notebook.ipynb" */%}}

示例笔记本

{{< callout type="info" >}}以下示例展示的是项目 assets 文件夹中包含的笔记本文件。{{< /callout >}}

{{% jupyter "example.ipynb" %}}