Markdown语法经典写作教程

1. Markdown简介

1.1 介绍

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTMLWord图像PDFEpub 等多种格式的文档。
Markdown编写的文档后缀为 .md, .markdown

1.2 Markdown 应用

Markdown 能被使用来撰写电子书,如:Gitbook
当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

目前主流编辑器:我推荐Typora 编辑器,Typora 支持 MacOS 、Windows、Linux平台,且包含多种主题,编辑后直接渲染出效果。支持导出HTML、PDF、Word、图片等多种类型文件。
Typora 官网:https://typora.io/


2.Markdown标题

2.1使用 =-标记一级和二级标题
我展示的是GitArtOS一级标题
======

效果:

我展示的是GitArtOS一级标题

我展示的是GitArtOS二级标题
-----------------

效果:

我展示的是GitArtOS二级标题

2.2 使用#号标记 可表示 1-6级标题,一级标题对应一个 #号,二级标题对应两个# 号,以此类推
# GitArtOS一级标题
## GitArtOS二级标题
### GitArtOS三级标题
#### GitArtOS四级标题
##### GitArtOS五级标题
###### GitArtOS六级标题

效果如下:

GitArtOS一级标题

GitArtOS二级标题

GitArtOS三级标题

GitArtOS四级标题

GitArtOS五级标题
GitArtOS六级标题

3.Markdown 段落

3.1Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车
wowoowoooowowoGitArtOS  
wwoowowowowowoGitArtOS

效果
wowoowoooowowo
wwoowowowowowo

3.2 当然也可以在段落后面使用一个空行来表示重新开始一个段落。
wowoowoooowowoGitArtOS

wwoowowowowowoGitArtOS

效果
wowoowoooowowoGitArtOS

wwoowowowowowoGitArtOS

3.3 字体

Markdown 可以使用以下几种字体:

*GitArtOS斜体文本*
_GitArtOS斜体文本_
**GitArtOS粗体文本**
__GitArtOS粗体文本__
***GitArtOS粗斜体文本***
___GitArtOS粗斜体文本___

效果

GitArtOS斜体文本
GitArtOS斜体文本
GitArtOS粗体文本
GitArtOS粗体文本
GitArtOS粗斜体文本
GitArtOS粗斜体文本

3.4 分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***
* * *
*****
- - -
----------

效果如下:






3.5 删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

GitArtOSGitArtOSGitArtOS.COM
GitArtOSGitArtOSGitArtOSGitArtOSGitArtOS.COM
~~GitArtOSGitArtOSGitArtOSGitArtOS.COM~~

效果
GitArtOSGitArtOSGitArtOS.COM
GitArtOSGitArtOSGitArtOSGitArtOSGitArtOS.COM
GitArtOSGitArtOSGitArtOSGitArtOS.COM

3.6 下划线

下划线可以通过 HTML<u> 标签来实现:

<u>带下划线文本</u>

效果

带下划线文本.png

3.7 脚注

脚注是对文本的补充说明。
Markdown 脚注的格式如下:

[^要注明的文本]

例如:

 创建脚注格式类似这样: [^RUNOOB]。

[^RUNOOB]: GitArtOS

效果

脚注.png


4.Markdown 列表

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

4.1 无序列表

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

* GitArtOS第一项
* GitArtOS第二项
* GitArtOS第三项

+ GitArtOS第一项
+ GitArtOS第二项
+ GitArtOS第三项


- GitArtOS第一项
- GitArtOS第二项
- GitArtOS第三项

显示效果

  • GitArtOS第一项
  • GitArtOS第二项
  • GitArtOS第三项
  • GitArtOS第一项
  • GitArtOS第二项
  • GitArtOS第三项
  • GitArtOS第一项
  • GitArtOS第二项
  • GitArtOS第三项
4.2 有序列表

使用数字并加上 . 号来表示,如:

1. GitArtOS第一项
2. GitArtOS第二项
3. GitArtOS第三项

显示效果:

  1. GitArtOS第一项
  2. GitArtOS第二项
  3. GitArtOS第三项
4.3 列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

显示效果

  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

5.Markdown 区块

5.1 区块引用

Markdown 区块引用是在段落开头使用>符号 ,然后后面紧跟一个空格符号

> 区块引用
> GitArtOS杂耍
> 学杂耍,我是认真的

效果如下:

区块引用
GitArtOS杂耍
学杂耍,我是认真的

5.2 区块嵌套

另外区块是可以嵌套的,一个> 符号是最外层,两个> 符号是第一层嵌套,以此类推:

> GitArtOS外套
> > GitArtOS内衣嵌套
> > > GitArtOS内裤嵌套
> > > > 你们真坏!!

效果:

GitArtOS外套

GitArtOS内衣嵌套

GitArtOS内裤嵌套

你们真坏!!

5.3 区块、列表正向杂交使用

区块使用列表实例

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

显示效果

区块中使用列表

  1. 第一项
  2. 第二项
  • 第一项
  • 第二项
  • 第三项
5.4 区块、列表反向杂交使用

列表中使用区块:如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。列表中使用区块实例如下:

* 第一项
    > GitArtOS学杂耍吗?
    > 学杂耍,我是认真的
* 第二项

显示效果

  • 第一项

    GitArtOS学杂耍吗?
    学杂耍,我是认真的

  • 第二项

6. Markdown代码---程序员环节了

6.2 简单的

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

`gitartos()` 函数

显示效果
gitartos() 函数

6.2 和编程语言相结合的

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

/```javascript
$(document).ready(function () {
    alert('RUNOOB');
});
```/

显示效果(去掉上面的/):

$(document).ready(function () {
    alert('RUNOOB');
});

7.Markdown链接

7.1 简单链接

链接使用方法如下:

[链接名称](链接地址)

或者

<链接地址>

举个🌰:

这是一个链接 [Markdown杂耍教程](https://www.jianshu.com/p/a41087cbe901)

显示效果:

这是一个链接 Markdown杂耍教程

当然你也可以直接使用链接地址:

<https://www.jianshu.com/p/a41087cbe901>

显示效果如下:

https://www.jianshu.com/p/a41087cbe901

7.2 高级链接

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

这个链接用 1 作为网址变量 [GitArtOS][1]
这个链接用 杂耍 作为网址变量 [GitArtOS][杂耍]
然后在文档的结尾为变量赋值(网址)

  [1]: https://www.jianshu.com/p/a41087cbe901
  [杂耍]: https://www.jianshu.com/p/a41087cbe901

显示效果:

这个链接用 1 作为网址变量 GitArtOS
这个链接用 杂耍 作为网址变量 GitArtOS
然后在文档的结尾为变量赋值(网址)


8.Markdown 图片

图标实例.jpg

Markdown 图片语法格式如下:

[图片上传失败...(image-a1511f-1613818429292)]

[图片上传失败...(image-14ffcf-1613818429295)]

GitArtOS1
GitArtOS2
8.1 当然,你也可以像网址那样对图片网址使用变量:
这个链接用 1 作为网址变量 [GitArtOS][1].
然后在文档的结尾为变量赋值(网址)

[1]: https://upload-images.jianshu.io/upload_images/19168340-e112b50cf76f07af.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

这个链接用 1 作为网址变量 GitArtOS.
然后在文档的结尾为变量赋值(网址)

8.2 Markdown还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的<img>标签。
<img src="https://upload-images.jianshu.io/upload_images/19168340-e112b50cf76f07af.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width="50%">

显示结果如下:

width=50%.png

9. Markdown 表格

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

语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

显示效果:

表头 表头
单元格 单元格
单元格 单元格
9.1 对齐方式
我们可以设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

举个🌰:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

以上代码显示结果如下:

左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

10.高级技巧

支持的HTML 元素不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。目前支持的HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

显示效果:


重启电脑20210220 18:46.png
10.1 转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

**文本加粗** 
\*\* 正常显示星号 \*\*

显示效果

文本加粗
** 正常显示星号 **

10.2 其他特殊符号

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号
10.3 公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeXLaTeX格式的数学公式来实现。提交后,问答和文章页会根据需要加载Mathjax 对数学公式进行渲染。如:

$$
\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
${$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$

输出结果为:

数学公式20210220 18.51.30.png

杂耍搞完,收藏起来,点赞关注我GitArtOS吧,终于凑足了10条。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容