发布于 2026-01-05 7 阅读
0

你唯一需要的 Markdown 速查表 Markdown 速查表

你唯一需要的 Markdown 速查表

Markdown 速查表

你肯定遇到过需要用 Markdown 编写内容的情况。

等等,Markdown到底是什么?它看起来像纯文本,感觉又有点像HTML,但它既不是纯文本也不是HTML?

别担心,我第一次用 Markdown 的时候也有点懵。但没过多久我就习惯了,而且发现它真的很棒。读完这篇文章,你就能掌握日常使用 Markdown 所需的一切知识。

打字机

伯纳德·赫曼特 (Bernard Hermant) 在 Unsplash 上拍摄的照片

好的,请你再告诉我一遍,Markdown是什么?我到底会在什么地方用到它?

Markdown 是一种轻量级的标记语言,可用于格式化纯文本文件。

您可能知道,GitHub 上的每个仓库都有一个 README 文件,用于解释仓库的用途。每个项目都需要完善的文档。GitHub 文档使用 Markdown 编写。正因如此,掌握一些基础知识至关重要。其次,一份吸引人的 README 文件能帮助您吸引新的联系人,拓展人脉。

好了!今天的理论就讲到这里。接下来是纯粹的实践部分。


Markdown 速查表

Markdown 可以编写很多元素,让我们深入了解一下。

📄 我还制作了这份速查表的PDF版本。您可以在这里找到并下载。欢迎使用和分享!✌🏼

PS:请注意,GitHub Markdown 目前仍不支持以下部分功能。或许未来会添加这些功能。您可以在这里找到专门为 GitHub Markdown 编写的详细文档的 GitHub 代码库链接

段落

通过编写正文,你实际上就是在编写一个段落。

段落

段落

标题

共有 6 种标题样式。标题后跟的“ # ”符号的数量表示标题的重要性。

标题

标题

强调

修改文本非常方便快捷。您可以将文本设置为粗体、斜体、删除线、高亮、下标或上标。

强调

强调

引用

想强调这段文字的重要性?无需多言。

引用

引用

图片

如果您使用 GitHub,最好的方法是直接将图片从您的计算机拖放到 README 文件中。您也可以创建图片引用并进行赋值。以下是语法。

图片

图片

链接

与图片类似,链接也可以直接插入或通过创建引用的方式插入。您可以创建行内链接和块级链接。

链接

链接

代码

您可以创建行内代码片段和完整代码块代码片段。您还可以使用反引号在代码片段中定义所使用的编程语言。

代码

代码片段

列表

与 HTML 一样,Markdown 也允许创建有序列表和无序列表。

有序列表

有序列表

无序列表

无序列表

您还可以将两个列表混合使用,并创建子列表。

PS:尽量不要创建超过两层的列表。这是最佳实践。

混音列表

混音列表

也可以创建定义列表(术语 — 定义),虽然您可能不经常使用,但确实存在这种可能性。

定义列表

定义列表

桌子

这是展示排列有序数据的绝佳方式。使用“ | ”符号分隔列,使用“ : ”符号对齐行内容。

桌子

桌子

你也可以通过省略外部的“ | ”符号,以及不规范代码结构来创建一个“杂乱”的表格。当然,它仍然可以运行,但是,我们应该始终以正确的方式处理细节问题。

凌乱的桌子

凌乱的桌子

任务清单

记录已完成的任务和需要完成的任务。

任务清单

任务清单

脚注

想在文件末尾描述某些内容?请使用脚注!

脚注

脚注

标题 ID

您可以为标题指定 ID,以便从文件的任何位置直接跳转到该部分。

标题 ID

标题 ID

水平线

您可以使用星号、连字符或下划线(*、-、_)来创建水平线。唯一的规则是符号必须至少包含三个字符。

水平线

水平线

HTML

你也可以在 Markdown 文件中使用纯 HTML。大多数情况下,这样做效果很好,但有时你可能会遇到一些与使用标准 HTML 时不同的情况。使用 CSS 则无法正常工作。

HTML

HTML

瞧!

感谢阅读!我向你展示了使用 Markdown 的所有优势。

您也可以在此处下载速查表的 PDF 版本并查看专门针对 GitHub Markdown 的文档

欢迎使用!如果您喜欢,请点个赞支持我,并关注我的社交媒体账号!✌🏼

另外,请查看我用 Markdown 创建的GitHub README 文件。

你也可以在这里找到一些很棒的 Markdown 文档


你总能在GitHubLinkedInTwitter上找到我。

让我们联系吧!📲

文章来源:https://dev.to/imluka/the-only-markdown-cheatsheet-you-will-ever-need-ccg