Markdown 是一种轻量级的标记语言，我们可以用它来格式化纯文本文档。

GitHub上的每个仓库都有自己的README文件，解释了该仓库的目的。每个项目都需要好的文档。GitHub 的文档是用 Markdown 编写的。这也正是为什么需要很好地处理一些基础知识。有很多元素你可以用Markdown来写，所以我们来深入了解一下。

段落

通过写常规文本，基本上是在写一个段落。

标题

有6种标题变体。符号 "#" 的数量，以及后面的文字，表明标题的重要性。

强调

修改文本是如此整洁和容易。你可以让你的文字变成粗体、斜体、删除线、高亮、下标或上标。

引用

图片

如果你使用的是GitHub，最好的方法是直接从电脑上拖放图片到README文件。你也可以为图片创建一个引用，并通过这种方式来分配它。以下是语法。

链接

与图片类似，链接也可以直接插入或通过创建一个参考。可以创建内联和块状链接。

代码

你可以创建内联式和全块式的代码片断。还可以定义在代码片段中使用的编程语言。所有这些都是通过使用反斜线。

列表

正如你在HTML中可以做的那样，Markdown允许创建有序和无序的列表。

也可以混合这两个列表并创建子列表。

还可以创建定义列表（术语-定义）：

表格

显示排列整齐的数据的好方法。使用**"|"** 符号来分隔列，使用 ":" 符号来对齐行内容。

也可以通过排除外部的 "|" 符号和不使你的代码有良好的结构来创建一个 "混乱的"表格。

列表

追踪已经完成的任务和需要完成的任务。

脚注

想在文件的末尾描述一些东西？用脚注吧!

标题标识

你可以给一个标题赋予ID，以便从你所在的地方直接跳到文件的那个部分。

你可以使用星号、连字符或下划线（*、-、_）来创建一个横线。唯一的规则是，你必须包括至少三个字符的符号。

这里，我创建了一个GitHub repo，大家可以用这个地址来练习：

https://github.com/im-luka/markdown-cheatsheet#html

原文：https://dev.to/imluka/the-only-markdown-cheatsheet-you-will-ever-need-ccg