Markdown的基本撰写和格式语法

基本撰写和格式语法

使用简单的语法在 GitHub 上为您的散文和代码创建复杂的格式。

本文内容

在这里插入图片描述

标题

要创建标题，请在标题文本前添加一至六个 # 符号。你使用的 # 数量将决定层次结构级别和标题的大小。

# A first-level heading
## A second-level heading
### A third-level heading

文本样式

可以在评论字段和 .md 文件中以粗体、斜体、删除线、下标或上标文本表示强调。

Style	语法	键盘快捷键	示例	输出
加粗	` ` 或 `__ __`	`Command`+`B` (Mac) 或 `Ctrl`+`B` (Windows/Linux)	`This is bold text`	这是粗体文本
斜体	`* *` 或 `_ _`	`Command`+`I` (Mac) 或 `Ctrl`+`I` (Windows/Linux)	`_This text is italicized_`	这是斜体文本
删除线	`~~ ~~`	无	`~~This was mistaken text~~`	~~这是错误文本~~
粗体和嵌入的斜体	` ` 和 `_ _`	无	`This text is _extremely_ important`	此文本_非常_重要
全部粗体和斜体	`* *`	无	`*All this text is important*`	所有这些文本都很重要
下标	`<sub> </sub>`	无	`This is a <sub>subscript</sub> text`	这是_下标文本
上标	`<sup> </sup>`	无	`This is a <sup>superscript</sup> text`	这是^上标文本

引用文本

可以使用 > 来引用文本。

Text that is not a quote

> Text that is a quote

引用文本缩进，具有不同的类型颜色。

在这里插入图片描述

引用代码

使用单反引号可标注句子中的代码或命令。反引号中的文本不会被格式化。你也可以按 Command+E (Mac) 或 Ctrl+E (Windows/Linux) 键盘快捷方式将代码块的反引号插入到 Markdown 一行中。

Use `git status` to list all new or modified files that haven't yet been committed.

![在这里插入图片描述](https://img-blog.csdnimg.cn/direct/74675e6801ac4a2a96bf9e326ef7b691.png)

支持的颜色模型

在问题、拉取请求和讨论中，可以使用反引号在句子中标注颜色。反引号内支持的颜色模型将显示颜色的可视化效果。

The background color is `#ffffff` for light mode and `#000000` for dark mode.

呈现的 GitHub Markdown 的屏幕截图，其中显示了反引号内的十六进制值如何创建有颜色的小圆圈。 #ffffff 显示一个白色圆圈，#000000 显示一个黑色圆圈。

下面是当前支持的颜色模型。

在这里插入图片描述

链接

通过将链接文本用方括号 [ ] 括起来，然后将 URL 用括号 ( ) 括起来，可创建内联链接。还可以使用键盘快捷方式 Command+K 创建链接。选择文本后，可以粘贴剪贴板中的 URL 以自动从所选内容创建链接。

还可以通过突出显示文本并使用键盘快捷方式 Command+V 创建 Markdown 超链接。如果要将文本替换为链接，请使用键盘快捷方式 Command+Shift+V。

This site was built using [GitHub Pages](https://pages.github.com/).

在这里插入图片描述

章节链接

你可以直接链接到渲染文件中的某个部分，方法是将鼠标悬停在该部分标题上以显示

在这里插入图片描述

relative links (相对链接)

您可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。

相对链接是相对于当前文件的链接。例如，如果在仓库根目录下有一个自述文件，而在 docs/CONTRIBUTING.md 中有另一个文件，则自述文件中的 CONTRIBUTING.md 的相关链接如下所示：

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub 将根据您当前使用的分支自动转换相对链接或图像路径，从而使链接或路径始终有效。链接的路径将相对于当前文件。以 / 开头的链接将相对于存储库根目录。可使用所有相对链接操作数，例如 ./ 和 ../。

相对链接更便于用户克隆仓库。绝对链接可能无法用于仓库的克隆 - 建议使用相对链接引用仓库中的其他文件。

图像

通过添加 ! 并将 alt 文本用 [ ] 括起来，可显示图像。替换文字是等效于图像中信息的短文本。然后将图像的链接用括号 () 括起来。

在这里插入图片描述

注意：想要显示存储库中的图像时，请使用相对链接而不是绝对链接。

下面是一些使用相对链接显示图像的示例。

上下文	相对链接
在同一分支的 `.md` 文件中	`/assets/images/electrocat.png`
在另一个分支的 `.md` 文件中	`/../main/assets/images/electrocat.png`
在仓库的议题、拉取请求和评论中	`../blob/main/assets/images/electrocat.png?raw=true`
在另一个存储库的 `.md` 文件中	`/../../../../github/docs/blob/main/assets/images/electrocat.png`
在另一个仓库的议题、拉取请求和评论中	`../../../github/docs/blob/main/assets/images/electrocat.png?raw=true`

注意：上表中的最后两个相对链接只有在查看者至少对包含这些图像的专用存储库具有读取访问权限时，才可用于专用存储库中的图像。

指定图像显示的主题

你可以通过结合使用 HTML <picture> 元素和 prefers-color-scheme 媒体功能来指定在 Markdown 中显示图像的主题。我们区分浅色和深色模式，因此有两个选项可用。可以使用这些选项来显示针对深色或浅色背景进行了优化的图像。这对于透明的 PNG 图像特别有用。

例如，以下代码显示浅色主题的太阳图像和深色主题的月亮：

<picture><source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png"><source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png"><img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

通过使用附加到 URL（#gh-dark-mode-only 或 #gh-light-mode-only）的片段来基于主题指定图像的旧方法已被弃用并将被删除，以支持上述新方法。

列表

可通过在一行或多行文本前面加上 -、* 或 + 来创建一个无序列表。

- George Washington
* John Adams
+ Thomas Jefferson

在这里插入图片描述

要对列表排序，请在每行前面添加一个编号。

1. James Madison
2. James Monroe
3. John Quincy Adams

在这里插入图片描述

嵌套列表

通过在一个列表项下面缩进一个或多个其他列表项，可创建嵌套列表。

若要使用 GitHub 上的 Web 编辑器或使用等宽字体的文本编辑器（例如 Visual Studio Code）创建嵌套列表，可以直观地对齐列表。在嵌套列表项的前面键入空格字符，直至列表标记字符（- 或 *）位于其上方条目中第一个文本字符的正下方。

1. First list item
   - First nested list item
     - Second nested list item

注意：在基于 Web 的编辑器中，可以先突出显示所需的行，然后分别使用 Tab 或 Shift+Tab 来缩进或取消缩进一行或多行文本。

要在 GitHub 上的评论编辑器中创建嵌套列表（不使用等宽字体），您可以查看嵌套列表正上方的列表项，并计算该条目内容前面的字符数量。然后在嵌套列表项的前面键入该数量的空格字符。

在本例中，可以通过将嵌套列表项缩进至少五个空格来在列表项 100. First list item 下添加一个嵌套列表项，因为在 First list item 前面有五个字符 (100 .)。

100. First list item
     - First nested list item

在这里插入图片描述

您可以使用相同的方法创建多层级嵌套列表。例如，由于在第一个嵌套列表项中，嵌套列表项内容 First nested list item 之前有七个字符 (␣␣␣␣␣-␣)，因此需要将第二个嵌套列表项至少缩进两个以上的字符（最少九个空格）。

100. First list item
       - First nested list item
         - Second nested list item

在这里插入图片描述

任务列表

若要创建任务列表，请在列表项前加连字符和空格，后接 [ ]。要将任务标记为完成，请使用 [x]。

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

在这里插入图片描述

如果任务列表项说明以括号开头，则需要使用 \ 进行转义：

使用表情符号

你可以通过键入 :EMOJICODE:（冒号后跟表情符号的名称）将表情符号添加到写作中。

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

键入 : 将显示建议的表情符号列表。列表将在你键入时进行筛选，因此一旦找到所需表情符号，请按 Tab 或 Enter 键以填写突出显示的结果。

段落

通过在文本行之间留一个空白行，可创建新段落。

脚注

您可以使用此括号语法为您的内容添加脚注：

Here is a simple footnote[^1].

A footnote can also have multiple lines¹.

脚注将呈现如下：

在这里插入图片描述

注意：Markdown 中脚注的位置不会影响该脚注的呈现位置。您可以在引用脚注后立即写脚注，脚注仍将呈现在 Markdown 的底部。

参考github文档中基本格式语法

To add line breaks within a footnote, prefix new lines with 2 spaces.
This is a second line.
↩︎