天天看点

Markdown 语法知多少?

大家好,我是坚果,我的公众号是“坚果前端”

今天是2021年11月4日星期四,

农历九月三十。

写作本文的目的是为了更好的与悟空做一比较

阅读本文,你可以打开 ​​在线 Markdown 编辑器 ​​。这样,你就可以一边学习 Markdown 语法一边练习了。熟悉 Markdown 之后,再选择一个顺手的 Markdown 的应用程序。

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,Markdown文件的后缀名便是“.md”。

​Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown 编写的文档后缀为 .md, .markdown。

专注于文字内容;

纯文本,易读易写,可以方便地纳入版本控制;

语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。

Markdown 能被使用来撰写电子书,如:Gitbook。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、码云,掘金,51CTO博客,简书、云+社区。华为云社区,StackOverflow、GitBook、有道云笔记、等等

还可以在一下场景使用

网站(hugo,hexo,wordpress,)

文件资料

笔记

书籍

演示文稿

邮件

文档

这是我推荐的一些Markdown文档创作工具:

现代编辑器

VSCode

传统编辑器

Vim / Emacs / Sublime Text / Notepad++

IDE 自带编辑器

IntelliJ IDEA / Android Studio / WebStorm

专用编辑器

Ulysses / Mou / Typora / Markpad

 ​​在线 Markdown 编辑器 ​​

Typora 官网:​​https://typora.io/​​

Mweb官网:​​https://zh.mweb.im/​​

这是一级标题

这是六级标题

在Markdown里面添加标题,你要在文本的前面添加一个井号 (​<code>​#​</code>​​)。 你可以键入多个井号来生成你想要的几级标题。 例如,一级标题你需要添加一个井号 (​<code>​# 一级标题​</code>​​), 当你需要一个三级标题时你就要三个井号 (​<code>​### 三级标题​</code>​).

Markdown 列表

Markdown 支持有序列表和无序列表。

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

​有序列表使用数字并加上 . 号来表示,如:

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

代码区块使用 4 个空格或者一个制表符(Tab 键)。

你也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

在 Markdown 中有两种不同的链接种类,但是它们的渲染方式完全相同。

第一种链接格式叫做 内联链接。创建一个内联的链接, 你需要将被链接的文本用方括号 ( ​<code>​[ ]​</code>​ )包裹起来, 然后将链接地址用圆括号 ( ​<code>​( )​</code>​ )包裹起来。 *这些括号及以后出现的括号均为英文半角符号,译者注。 比方说,创建一个写着 "坚果的51博客" 到 ​​​​https://blog.51cto.com/jianguo​​​​ 的超链接, 你应该使用Markdown这样书写: ​<code>​[坚果的51博客](​​https://blog.51cto.com/jianguo​​)​</code>​.

另外一种链接叫做 全局 链接。顾名思义,这个链接链接到文档的另外一个位置。这里有一个示例来说明我们想表达什么:

​我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:

第一种图片的格式叫做 内联图片链接。创建一个内联的图片链接, 需要输入一个感叹号 ( ​<code>​!​</code>​​ )将方括号 ( ​<code>​[ ]​</code>​​ )中的描述性文本包裹起来, 然后使用圆括号 ( ​<code>​( )​</code>​ )包裹链接地址。 (描述性文本是为视障者解释图片短语或者句子的语句。)

例如,创建一个描述文本为"jianguo"的内联的链接地址为 jianguo 的图片, 你应该这样写Markdown: 

​​​

Markdown 语法知多少?

​​

当然,你也可以像网址那样对图片网址使用变量:

Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 &lt;img&gt; 标签。

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

语法格式如下:

<col>

表头

单元格

对齐方式

我们可以设置表格的对齐方式:

-: 设置内容和标题栏居右对齐。

:- 设置内容和标题栏居左对齐。

:-: 设置内容和标题栏居中对齐。

左对齐

右对齐

居中对齐

在Markdown让一些文本 斜体 ,你可以使用下划线 (​<code>​_​</code>​ ) 包裹文本。 例如, ​<code>​_这个_​</code>​ 词将会变成 斜体。

同理,在Markdown中将一些文本加粗, 你可以使用两个星号包裹文本 ( )。这将**真的** 会吸引你的注意。

当然,你可以在同一行中使用 ​<code>​_斜体和粗体_​</code>​。你也可以 ​<code>​**跨越 多个 词语**​</code>​.

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:​<code>​&lt;kbd&gt; &lt;b&gt; &lt;i&gt; &lt;em&gt; &lt;sup&gt; &lt;sub&gt; &lt;br&gt;​</code>​等 ,如:

Markdown 语法知多少?
Markdown 语法知多少?

网上有很多资源用来学习 Markdown。以下列出一些:

​​Markdown Tutorial​​. 一个开源网站,你能用浏览器在这个网站上尝试 Markdown。

​​Typesetting Markdown​​​. 这是一个系列教程,介绍了使用 ​​pandoc​​​ 和 ​​ConTeXt​​ 对 Markdown 文档进行排版的系统。

目前由于悟空不支持甘特图,流程图等。所以在这儿不方便展示。

希望悟空早日上线这个功能!

后面也会出一期如何使用wukong写作的博客。

下面是我的公众号,欢迎大家扫码关注。

Markdown 语法知多少?

继续阅读