跳至主要内容

Jupyter Notebook 中的 Markdown 教程

在本教程中,您将学习如何在 Jupyter Notebook 中使用并书写不同的标记标签。
· 9分钟 阅读

使用 AI 探索

Markdown 是一种轻量且流行的标记语言,是数据科学家和分析师的写作标准。它通常通过 Markdown 处理器转换为相应的 HTML,从而能够在不同设备和人之间轻松共享。

标记语言与超文本标记语言(HTML)类似,由标记标签组成,包括开始标签 <tagname> 和结束标签 </tagname>。

在本教程中,您将看到使用标记标签与 Jupyter Notebook 所支持的 Markdown 语法得到的相同效果。

您需要安装 Jupyter Notebook。可以参考 DataCamp 的教程进行环境搭建:Jupyter Notebook 教程:权威指南。

在 Jupyter Notebook 中,可以通过下拉菜单选择 Markdown 单元,或在插入新单元后立即使用键盘快捷键“m/M”。

markdown cell

在线运行和编辑此教程中的代码

运行代码

标题

标题以“#”号开头,即井号后跟空格。共六级标题:最大标题只用一个井号,最小标题使用六个井号。

#(一级标题,标题)

##(二级标题,主要标题)

###(三级标题,副标题)

####(四级标题)

#####(五级标题)

######(六级标题)``

另外,也可以使用标记标签从 h1 到 h6 来表示标题,语法如下。

<h1>Header 1,title<h1>
<h2>Header 2,major headings<h2>
<h3>Header 3,subheadings<h3>
<h4>Header 4<h4>
<h5>Header 5<h5>
<h6>Header 6<h6>

以上两种语法在点击工具栏中的“Run”后都会渲染出 h1 到 h6 的标题。

Headings

引用块

引用块可以容纳较大段落的文本,通常会缩进。可使用 Markdown 符号“>”或使用 <blockquote>引用文本</blockquote> 来实现。

  • >This is good
  • <blockquote>This is good</blockquote>

以上两种语法在点击工具栏“Run”后都会以缩进形式渲染文本。

Blockquotes

代码区域

代码区域用于展示不同编程语言的代码。行内代码用反引号括起:‘ `inline code goes here` ’;代码块使用三个反引号:‘ ``` block line code goes here ``` ’。此外,代码区域的标记标签为‘ <code>code goes here<code> ’。

下面是行内代码示例:
`x =5`

点击“Run”后,您会看到行内代码以高亮形式渲染。

Code Section

下面是代码区域示例:

    • 使用 Markdown
    • ```Python
      str = "This is block level code"
      print(str)
      ```
    • 使用标记标签
    • <code>Python
      str = "This is a block level code"
      print(str)
    </code>

使用 Markdown,如果在三个反引号“```”后注明编程语言名称,即可获得代码的语法高亮,示例如下:

Code Section

仅使用 Markdown 而不指定语言时,不会有语法高亮,但代码仍会被高亮显示:

Code Section

数学符号

在 Markdown 中,数学表达式使用美元符号包裹:'\$ 数学表达式 \$'。关于标记中的数学符号,您可以参考此链接了解更多详情:Mathematical Operators。下面是使用数学符号的示例。

\$\sqrt{k}$

上述示例将以加粗形式渲染数学表达式。

Mathematical Symbol

换行

换行标签使用不带结束标签的 <br> 来打断当前行,使后续内容从新的一行开始,如下例所示。

The line breaks after using <br> br tags and it is awesome.

点击工具栏中的“Run”后,您将看到在使用 <br> 标签的地方出现换行,剩余文本从新的一行开始。

Line Break

加粗与斜体

要获得加粗文本,您可以使用 <b> 标签、“**”(双星号)或“__”(双下划线),语法如下。

  • <b>This is bold text </b>
  • ** This is bold text
  • __ This is bold text

以上语法在点击工具栏“Run”后都会渲染为加粗文本。

Bold and Italic Text

要获得斜体文本,您可以使用 <i> 标签、“*”(单星号)或“_”(单下划线),语法如下。

    • <i>This is italic text </i>
    • * This is italic text
    • _ This is italic text

以上语法在点击工具栏“Run”后都会渲染为斜体文本。

Bold and Italic Text

水平线

您可以使用 Markdown 的“---”(三个连字符)或标记标签 <hr> 来绘制水平线。

以上两种语法在点击“Run”后都会渲染贯穿页面的水平线。

Horizontal Line

有序列表

有序列表是编号列表,使用 <ol> 开始、</ol> 结束,列表项位于 <li> 与 </li> 标签之间。标签“ol”为 ordered list(有序列表)的缩写,“li”为 list item(列表项)的缩写。下面是一个包含购物项的有序列表示例。

<ol>
<li>Fish</li>
<li>Eggs</li>
<li>Cheese</li>
</ol>

或者,您也可以用“1. ”这样的数字加空格来列出,如下所示。

  1. Fish
  2. Eggs
  3. Cheese

以上两种语法在点击工具栏“Run”后都会渲染为编号列表。

Ordered List

无序列表

无序列表是项目符号列表,使用 <ul> 开始、</ul> 结束,示例如下:

<ul>
<li>Fish</li>
<li>Eggs</li>
<li>Cheese</li>
</ul>

另外,无序列表也可以用“-”加空格开始,呈现黑色圆点;或用“*”加空格开始,呈现黑色方块。

-   Fish
-   Eggs
-   Cheese

上述示例展示了使用“-”加空格作为项目符号,渲染为黑色圆点的列表。

以上两种语法在点击工具栏“Run”后都会渲染相同的结果:列表项以黑色圆点显示。

Unordered List

内部链接 在 Markdown 中以 <a> 标签开始,通过属性“id”定义唯一的标识符,可在 Notebook 中进行链接,示例如下:

<a id = "division_ID"text goes here></a>

同时,可以通过以下代码将上面定义的 id 链接到 Notebook 的某个章节,使其成为可点击的链接。

[Section title](#division_ID)

如下图所示,定义的 id 与章节建立了链接,点击工具栏“Run”后可获得可点击的链接。

Internal and External Link

外部链接 在 Markdown 中以 <a> 开始、以 <a> 结束,即 <a> 表示用于定义链接的锚点标签。其属性“href”也称为超链接引用,包含链接的目标地址或 URL,标签之间的文本为可见且可点击的内容,用于打开目标地址,如下所示。

<a> href="https://www.google.com" >Link to Google</a>

或者,也可以使用 __[text link](URL for the site)__ 的格式:在文本链接两侧加双下划线,文本链接置于方括号内,站点 URL 置于圆括号内。

Link to Google

以上两种语法在点击工具栏“Run”后都会渲染相同的结果:可点击并带下划线的文本会在新页面打开。

Internal and External Link

表格

表格以行和列呈现信息。使用“|”(竖线)分隔各列,使用“-”(连字符)创建表头;空白分隔行(竖线与连字符的组合)用于渲染表格格式。

您也可以大致按列对齐单元格,Notebook 会自动调整单元格内的内容大小。

|Name|Address|Salary| |-----|-------|------| |Hanna|Brisbane|4000| |Adam|Sydney|5000|

另外,也可以用 Markdown 的表格标记来构建表格,其中 < table > 用于定义表格并可设置百分比宽度。<tr> 设置表格行,表头使用 <th>,位于表格顶部,其余表格项使用 <td>(表格数据标签)。

<table style="width:20%">
<tr>
<th><Name></th>
<th><Address></th>
<th><Salary></th>
</tr>

<tr>
<td><Hanna></td>
<td><Brisbane></td>
<td><4000></td>
</tr>

<tr>
<td><Adam></td>
<td><Sydney></td>
<td><5000></td>
</tr>
</table>

以上两种语法在点击“Run”后都会渲染相同的结果。

Table

图片

您可以通过工具栏中的 Edit 菜单选择“Insert Image”插入图片,并浏览所需图片,如下所示。

Images

Images

图片也可以使用 Markdown 的 <img> 标签插入,其中 src 属性为图片链接,并可选设置宽度与高度,示例如下。

<img> <src="https://i.imgur.com/WWrydEh.png" width ="500" height=500 >

以上两种方式在点击工具栏“Run”后都会渲染相同的图片。

image

结语

在本教程中,您学习了由标记语言定义的不同标记标签,以及特定于 Jupyter Notebook 的 Markdown 单元语法。这些语法可以与代码并排使用,更有效地描述内容。

如果您想进一步了解 Markdown,请参阅 Markdown 指南。

主题