Markdown (opens new window)是一种轻量级、开源、易于阅读和编写的文本格式化方法，您可以将其用作任何IDE或编辑器中的纯文本。
在GitHub上编写时，您可以使用Markdown语法和HTML元素来扩展Markdown的功能。您可以在GitHub的各个地方使用Markdown语法，例如README文件、wiki、评论、拉取请求以及创建问题时。
对于每位软件开发人员来说，学习markdown是您职业道路上的一个重要步骤。
为了增强Markdown的基本功能，GitHub添加了一些自定义功能，并创建了GitHub风格的Markdown (opens new window)。通过这个，您可以轻松在拉取请求和问题中与其他用户互动，提到用户、问题和PR引用并添加表情符号。
本教程教您GitHub-Flavored Markdown的基础知识，这样您就可以开始在项目中使用它。
所有代码都在GitHub存储库中 (opens new window)可用。
GitHub风格Markdown语法分为两部分。
我们将在下面详细讨论每一项。
基本格式语法 #
基本格式语法适用于每个人。它包含基本要素，如标题、代码、图像、引用、链接等，这些是您写作所需了解的内容。
请注意，代码示例主要来自GitHub的文档 (opens new window)。
标题 #
您可以使用#符号创建标题。一个#创建一个H1标题，两个创建一个H2标题，依此类推，如下所示：
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
在Markdown中创建标题
段落 #
要创建段落，您可以使用一个空行来分隔一个或多个文本行或段落。
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam est odio, commodo id diam sed, pulvinar sagittis tortor. Nam vestibulum purus eros. Sed congue, mi id pretium auctor, nibh augue iaculis arcu, eu tristique quam dolor at erat.
Quisque vel odio condimentum, mollis sem vitae, porta diam. Praesent ligula elit, condimentum eget ex sed, commodo sollicitudin sapien.
Proin volutpat faucibus nulla. Nullam eros sem, ultricies gravida nunc nec, dapibus posuere nisl. Nunc lacinia elementum turpis in pharetra. Aenean eu neque eros.
在Markdown中创建段落。 - 9999], [4000, 0]]] }
Create topojson in markdown
Mathematical expressions #
To add mathematical expressions to a GitHub markdown file, you can use LaTeX. LaTeX is a high-quality typesetting system widely used for scientific and mathematical documents.
To include mathematical expressions, wrap the LaTeX code inside dollar signs $ or double dollar signs $$.
Example:
$e^{i\pi} + 1 = 0$
Creating mathematical expressions in markdown
The mathematical expression looks like this in the browser:
Mathematical expression example in markdown. ```json [9999, [-2000, 0]]
创建一个Markdown中的TopJson
### ASCII STL
GitHub Flavored Markdown支持STL语法。STL语法允许您在Markdown中添加交互式3D模型。您可以使用以下语法：```stl your code.```
```stl
solid cube_corner
facet normal 0.0 -1.0 0.0
outer loop
vertex 0.0 0.0 0.0
vertex 1.0 0.0 0.0
vertex 0.0 0.0 1.0
endloop
endfacet
facet normal 0.0 0.0 -1.0
outer loop
vertex 0.0 0.0 0.0
vertex 0.0 1.0 0.0
vertex 1.0 0.0 0.0
endloop
endfacet
facet normal -1.0 0.0 0.0
outer loop
vertex 0.0 0.0 0.0
vertex 0.0 0.0 1.0
vertex 0.0 1.0 0.0
endloop
endfacet
facet normal 0.577 0.577 0.577
outer loop
vertex 1.0 0.0 0.0
vertex 0.0 1.0 0.0
vertex 0.0 0.0 1.0
endloop
endfacet
endsolid
在Markdown中创建ASCII STL
浏览器中的STL语法如下所示：
Markdown中的STL示例
数学表达式 #
您可以在GitHub的Markdown文件中添加数学表达式，如方程式、术语、公式等。GitHub使用Markdown中的LaTeX格式。有两种方法可以添加这些表达式：
- 编写内联数学表达式
- 将数学表达式写为代码块
编写内联数学表达式 #
内联数学表达式以$开头，以$结尾。
内联数学表达式示例：$\sqrt{3x-1}+(1+x)^2$
内联数学表达式示例
浏览器中的内联数学语法如下所示：
内联数学表达式示例
将数学表达式写为代码块 #
要将数学表达式的代码块添加到Markdown文件中，请使用```math代码块，并将其包裹在三个反引号中以将表达式显示为块。
```math
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
代码块数学表达式示例
浏览器中的数学代码块语法如下所示：
代码块数学表达式示例
## 结论
Markdown语法在GitHub和其他中央Git服务器（如GitLab、Gitea等）中都能很好地工作。
不同的工具以不同的方式命名它们的Markdown。例如，GitHub通过自己的方式扩展了Markdown的功能，并构建了GitHub Flavored Markdown。GitLab也扩展了Markdown的功能，并构建了GitLab-flavored markdown。
Markdown语法在每个Git服务中基本上都是相同的。但是，警报、图表和其他一些功能只在GitHub Flavored Markdown中起作用。
## 参考
* GitHub文档 - [GitHub上的快速入门指南](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)
* GitHub文档 - [基本语法](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
* 有关在GitHub的Markdown中呈现STL的教程 [教程](https://www.vanderveer.io/github-markdown-render-stl/)
---
---
免费学习编程。freeCodeCamp的开源课程帮助超过40,000人成为开发人员。[开始学习](https://www.freecodecamp.org/learn/)