您可以使用Markdown标记来提高项目自述或Jupyter笔记本中Markdown单元的可读性。 其中标注了自述文件中和 Notebook 中的 Markdown 之间的差异。
标题:使用 # 后跟空格来表示 Notebook 标题和小节标题:
#
title
##
主要标题
###
子标题
####
4th 级子标题
重点:使用以下代码:粗体:__string__
或 **string**
;斜体:_string_
或 *string*
;删除线:~~string~~
数学符号:使用以下代码:$ mathematical symbols $
等宽字体: 用后单引号 (`) 括起文本。 对文件路径和文件名使用等宽空间,并对文本用户输入或消息文本用户看到的内容使用等宽空间。
换行符:有时,Markdown 无法在需要换行的位置换行。 请在行尾放置两个空格,或者使用以下代码进行手动换行:<br>
缩进引用:使用大于符号 (>
),再使用空格,然后输入文本。 文本将缩进,并在其左侧具有一条灰色水平线,直至下一个回车符为止。
项目符号: 使用带有空格的短划线 (-
) 或空格,短划线和空格 (-
) 来创建圆形项目符号。 要创建子项目符号,请使用 Tab 键后跟短划线和空格。 您还可以使用星号代替短划线,并且其作用相同。
编号列表:以 1.
开头,后跟空格,然后是文本。 点击回车键,然后将自动编号。 每行以某个数字和句点开头,后跟空格。 点击 Tab 键以缩进,从而获取编号。
自述文件中的复选框: 将此代码用于未选中的框: - [ ]
将此代码用于选中的框: - [x]
自述文件中的表:使用以下代码:
| Heading | Heading |
| ----| ----|
| text | text |
| text | text |
Notebook 中的图形:将图像拖放到 Markdown 单元格即可将其附加到 Notebook 中。 要将图像添加到其他单元类型,请使用此代码在 Web 上托管的图形,将 url/name 替换为图像的完整 URL 和名称: <img src="url/filename.gif" alt="Alt text" title="Title text" />
自述文件中的图形: 使用以下代码: ![Alt text](url/filename.gif "Title text")
几何形状: 将此代码与此处的十进制或十六进制引用号配合使用: UTF-8 几何形状 &#reference_number;
水平线:使用三个星号:***
内部链接:要链接到某个部分,请在该部分标题上方添加一个锚点,然后创建一个链接。
使用以下代码创建锚点: <a id="section_ID"></a>
使用以下代码创建链接: [section title](#section-ID)
确保 section_ID 在笔记本或自述文件中是唯一的。
或者,对于 Notebook ,您可以跳过创建锚点并使用以下代码: [section title](#section-title)
对于括号中的文本,将空格和特殊字符替换为连字符,并使所有字符都小写。
测试所有链接!
外部链接:使用以下代码:[link text](http://url)
要创建在新窗口或选项卡中打开的链接,请使用以下代码: <a href="http://url" target="_blank" rel="noopener noreferrer">link text</a>
测试所有链接!
父主题: 项目