Fork me on GitHub

Markdowm入门

[TOC]

前言

Markdown 是一种轻量级的标记语言,其用简单的标记语法便可达到排版的目的,其可以使我们更加专注于内容的编写,而不需过多关注排版。本文主要整理了 Markdown 中的常用的标记语法,以便自己与他人以后查用。

Markdown编辑器

推荐:Atom
使用Markdown格式的场景: Hexo博客,简书
其他Markdown编辑器产品

Atom介绍

Atom 是 Github 官方开发的一款可定制化的、跨平台的文本编辑器。有两点需要注意一下,一是 Atom 是由 Github 官方开发,二是其定制化程度非常高。前者的结果是编辑器对 Github 非常友好,如果项目托管在 Github 上的话,用 Atom 可以很方便地进行 Git 操作。后者的结果就是我们可以根据自己的需要定制自己的编辑器,使得自己的效率最大化,也让自己舒舒服服、开开心心地码代码。
Atom预览Markdown快捷键:Ctrl+Shift+M
Atom相关资料

Markdown语法介绍

献给写作者的 Markdown 新手指南
Markdown 语法说明 (简体中文版)

段落与换行

Markdown中段落指连续的一段文字,编写时段落之间至少一个空行隔开,段落内多个空格被视为一个空格,段首不支持缩进。
如何想要在显示时显示多个空行,可以插入
实现,注意的是,插入的
应与前后的段落中间至少空一行。

标题

Markdown支持两种类型的标题
方法1:只能表示两个级别

1
2
3
4
一级标题
========
二级标题
--------

方法2:推荐

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

强调

星号或者下划线都可以,单是斜体,双是粗体,符号可以跨行,符号可加空格

1
2
3
4
5
6
7
8
9
10
** 我是被强调的字段 **
__ 我是被强调的字段__

**
跨行
跨行
**

*斜体*
_ 斜体_

效果如下:
** 我是被强调的字段 **
__ 我是被强调的字段__

**
跨行
跨行
**

斜体
_ 斜体_

分割线

三个或更多-_*,必须单独一行,可含空格

1
2
3
- - -
***
___

效果如下:




引用

1
2
>引用
>> 引用中的引用

效果:

引用

引用中的引用

序列

无序列表

符号之后的空格不能少,-+*效果一样,但不能混合使用,因混合是嵌套列表,内容可超长

1
2
3
4
5
6
7
8
9
10
11
12
13
14
- 无序列表
- 无序列表
- 无序列表
- 无序列表:我很长。我也很长!那比一比啊?比就比!我有这么长,你有我长吗?我有这么这么长!就是这么长!

* 无序列表
* 无序列表
* 无序列表
* 无序列表:我很长。我也很长!那比一比啊?比就比!我有这么长,你有我长吗?我有这么这么长!就是这么长!

+ 无序列表
+ 无序列表
+ 无序列表
+ 无序列表:我很长。我也很长!那比一比啊?比就比!我有这么长,你有我长吗?我有这么这么长!就是这么长!

三种效果都是一样的,如下:

  • 无序列表
  • 无序列表
  • 无序列表
  • 无序列表:我很长。我也很长!那比一比啊?比就比!我有这么长,你有我长吗?我有这么这么长!就是这么长!

有序列表

数字不能省略但可无序,点号之后的空格不能少

1
2
3
4
1. 有序列表
2. 有序列表
3. 有序列表
4. 有序列表

效果:

  1. 有序列表
  2. 有序列表
  3. 有序列表
  4. 有序列表

嵌套列表

-+*可循环使用,但符号之后的空格不能少,符号之前的空格也不能少

1
2
3
4
5
6
- 嵌套列表1
+ 嵌套列表2
+ 嵌套列表3
- 嵌套列表4
* 嵌套列表5
- 嵌套列表6

效果如下:

  • 嵌套列表1
    • 嵌套列表2
    • 嵌套列表3
    • 嵌套列表4
      • 嵌套列表5
  • 嵌套列表6

文字超链

Tooltips可省略

1
[不如](http://bruce-sha.github.io "不如的博客")

效果如下:
不如

图片超链

多个感叹号,Tooltips可省略,要设置大小只能借助HTML标记

1
![GitHub Mark](http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark")

效果如下:
GitHub Mark

索引超链

索引,1 可以是任意字符

1
2
3
[不如][1]
[1]:http://bruce-sha.github.io
效果如下:

[不如][1]
[1]:http://bruce-sha.github.io

自动链接

尖括号

1
2
<http://ibruce.info>
<[email protected]>

效果如下:
http://ibruce.info
bu.ru@qq.com

代码

行内代码

1
2
3
4
5
6
7
8
9
10
11
``` python
@requires_authorization
def somefunc(param1='', param2=0):
'''A docstring'''
if param1 > param2: # interesting
print 'Greater'
return (param2 - param1 + 1) or None
class SomeClass:
pass
>>> message = '''interpreter
... prompt'''
1
2
3
4
5
6
7
8
9
10
11
12
可代码高亮
``` python
@requires_authorization
def somefunc(param1='', param2=0):
'''A docstring'''
if param1 > param2: # interesting
print 'Greater'
return (param2 - param1 + 1) or None
class SomeClass:
pass
>>> message = '''interpreter
... prompt'''

段落代码

每行文字前加4个空格或者1个Tab

1
2
3
4
val s = "hello Markdown"
println( s )
val s = "hello Markdown"
println( s )

效果如下:
val s = “hello Markdown”
println( s )
val s = “hello Markdown”
println( s )

注释

用html的注释

1
<!-- 用html的注释 -->
这有内容就是被注释了,所以未显示

转义字符

用html的注释,好像只有这样?
Markdown中的转义字符为\,转义的有:

1
2
3
4
5
6
7
8
9
10
11
12
\\ 反斜杠
\` 反引号
\* 星号
\_ 下划线
\{\} 大括号
\[\] 中括号
\(\) 小括号
\# 井号
\+ 加号
\- 减号
\. 英文句号
\! 感叹号

效果如下:
\ 反斜杠
` 反引号
* 星号
_ 下划线
{} 大括号
[] 中括号
() 小括号
# 井号
+ 加号
- 减号
. 英文句号
! 感叹号

删除线语法

支持两种方法:

1
2
~~我是被删除的~~
<del> 我是被删除的 </del>

效果如下
我是被删除的

插入图片

语法

1
![](/68cb3bb5/lifecycle.png)

效果如下:

注:相关内容扩展,如何控制图片显示大小等等

生成表格

md原生

1
2
3
4
5
| 水果        | 价格    |  数量  |
| -------- | -----: | :----: |
| 香蕉 | $1 | 5 |
| 苹果 | $1 | 6 |
| 草莓 | $1 | 7 |

效果如下:

水果价格数量
香蕉$15
苹果$16
草莓$17

HTML表格

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<table>
<tr>
<th>设备</th>
<th>设备文件名</th>
<th>文件描述符</th>
<th>类型</th>
</tr>
<tr>
<th>键盘</th>
<th>/dev/stdin</th>
<th>0</th>
<th>标准输入</th>
</tr>
<tr>
<th>显示器</th>
<th>/dev/stdout</th>
<th>1</th>
<th>标准输出</th>
</tr>
<tr>
<th>显示器</th>
<th>/dev/stderr</th>
<th>2</th>
<th>标准错误输出</th>
</tr>
</table>

效果如下:

设备设备文件名文件描述符类型
键盘/dev/stdin0标准输入
显示器/dev/stdout1标准输出
显示器/dev/stderr2标准错误输出
### execl表格 项目地址:https://github.com/fanfeilong/exceltk 有兴趣的同学可以自己测试下,未测试.

段落缩进(空格)

1
2
3
4
半方大的空白&ensp;或&#8194;看,飞碟
全方大的空白&emsp;或&#8195;看,飞碟
不断行的空白格&nbsp;或&#160;看,飞碟
&emsp;&emsp;段落从此开始。

效果如下:
半方大的空白 或 看,飞碟
全方大的空白 或 看,飞碟
不断行的空白格 或 看,飞碟
  段落从此开始。

字体、字号、颜色、背景色

1
2
3
4
5
6
7
<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=12 face="黑体">黑体</font>
<font color=#00ffff size=3>null</font>
<font color=gray size=5>gray</font>
<table><tr><td bgcolor=#FF4500>这里的背景色是:OrangeRed, 十六进制颜色值:#FF4500, rgb(255, 69, 0)</td></tr></table>

效果如下:
我是黑体字
我是微软雅黑
我是华文彩云
黑体
null
gray

这里的背景色是:OrangeRed, 十六进制颜色值:#FF4500, rgb(255, 69, 0)
## 标签 ### 行内标签
1
快捷键 `Ctrl + D` 来收藏本页

效果如下:
快捷键 Ctrl + D 来收藏本页

注脚

不是标准 MarkDown的范畴,各个扩展的定义可能有所不同.

其他

参考资料

Markdown 快速生成表格
markdown 语法之字体、字号、颜色以及背景色
markdown语法实例

======================================================
希望各位朋友支持一下

本文作者:dongsheng
本文地址https://mds1455975151.github.io/archives/5d3f2cbe.html
版权声明:转载请注明出处!

坚持技术分享,您的支持将鼓励我继续创作!