作为一个程序员,我个人是非常喜欢用简书的,因为简书上的文章大部分都有清晰的条理结构和优雅的界面,这对技术类文章是非常重要的。好了,废话不说,下面我们就了解一下写文章时需要用到的一些markdown语法。让自己也能写出界面优雅、条理清晰的文章。
0.前置条件
我们要使用带有markdown特殊格式的文章排版,必须要将基础设置里面的常用编辑器设置为markdown。设置流程如图:
一、Markdown语法基础篇
1. 标题
标题用1~6个#号标记,分别代表 一级~六级标题,多余6个以上的#自动蜕变为普通文字。
语法:
#标题名
示例:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
####### 哈哈,没有7级标题哦
效果:
2. 代码框
作为开发者,插入代码框是必须要会的。代码框语法为,也就是因英文状态下的波浪线(~)那个按键。
语法:
``` 代码内容 ```
示例:
```
override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
let configuration = ARWorldTrackingConfiguration()
sceneView.session.run(configuration)
}
```
效果:
3.代码片
这个东西跟代码框其实差不多,只不过当一行的代码足够长时,代码框可以左右滑动,而代码片不会,代码片会在其包裹的内容上蒙上一层淡淡的底色。
语法:
` 代码块 `
示例:
`
let gridMaterial = SCNMaterial() gridMaterial.diffuse.contents = UIImage(named: "art.scnassets/grid.png")
plane.materials = [gridMaterial]
`
效果:
4.无序列表
无序列表的实现方式很简单,有三种:分别在文字前面加上 * 、- 、+ 中的其中一种即可。注意符号需要与文字空一个空格。
语法:
* 文字
- 文字
+ 文字
示例:
* 无序列表1
- 无序列表2
+ 无序列表3
效果:
5.有序列表
有序列表的实现是 ‘数字加点’,后面接上需要描述的文字即可,注意需要要与文字空一个空格。
语法:
数字编号. 文字
示例(有序无序列表嵌套):
注意: 如需列表嵌套,上一级和下一级之间敲三个空格即可
1. 一级有序列表
* 二级有序列表
效果:
6.引用
我们在写文章时,有时需要借鉴、引用他人的文字或论证,这时引用就变得有必要了。引用语法很简单,一个 > 符号就可以。引用可以多层嵌套,每进一层,多加一个>就可以了,可以加很多层。
语法:
> 所引用的内容
>> 所引用的内容
示例:
>凤兮凤兮归故乡,遨游四海求其凰
>>凤凰鸣矣,于彼高岗;梧桐生矣,于彼朝阳
>>>大河之剑天上来
效果:
7.强制换行
markdown编辑器下直接回车,预览时换行是显示不了的。这时就需要强制换行了。
语法:
<br>
示例:
第一行文字
<br>
第二行文字
效果图:略
8.转义字符
当我门需要直接打印出每个带有图书意义的字符时,就需要一个转义字符,讲那个特殊字符转换为普通字符,这时才能打印。比如代码框符号```,引用符号>等。这个转义字符就是反斜杠 \。
语法:
\需要转义的字符
示例:
\```
\>
\<br>
效果:
9.链接
当我们的文章有需要跳转其他资源的需求时,此时就需要一个链接。链接的标记格式为[需要跳转资源的文字描述
](http资源地址
),这样我们点击文字描述,就能直接跳转到相应的资源。
语法:
[需要跳转资源的文字描述](http资源地址)
示例:
你可以在 [简书](http://www.jianshu.com/) 上写出优美的文章
效果:
10.插入图片
插入图片的语法跟链接差不多,多一个!,标记格式为![想要显示的图片名
](图片地址
)
语法:
![想要显示的图片名](图片地址)
示例:
![美女小姐姐](http://upload-images.jianshu.io/upload_images/2978034-fd317044c63cd724?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果:
11. 字体
字体语法可以组合起来使用。
语法:
**加粗**
*倾斜*
_倾斜_
***斜体加粗***
~~加删除线~~
~~*加删除线的倾斜*~~
示例:
**这是加粗的文字**
*这是倾斜的文字*
_这是倾斜的文字_
***这是斜体加粗的文字***
~~这是加删除线的文字~~
~~*这是加删除线的倾斜文字*~~
效果:
12. 分割线
语法:
三个或以上的*或-都可以
示例:
***
---
************
------
效果:
二、Markdown语法进阶篇
1. 上标、下标
语法一 :
Markdown兼容HTML的语法,所以使用HTML中上下标的语法即可。
上标: <sup>文字</sup>
下标: <sub>文字</sub>
语法二 :
这种语法有一定兼容性问题,在某些平台上可能显示不出来,比如在掘金上以这种方式实现的商标,没有任何效果,以这种方式实现的下标则变成了删除线。而这种语法在简书上的显示都符合预期。
上标: ^文字^
下标: ~文字~
示例:
水的分子式为:
H<sub>2</sub>O
H~2~O
圆的面积为:
πr<sup>2</sup>
πr^2^
Tencent^这是一个商标TM^
效果:
2. 表格
语法:
第二行分割表头和内容。
- 有一个就够了,为了看起来整齐,可以随意添加。
文字对其方式: 默认居左
-两边加:表示文字居中
-右边加:表示文字居右
| 表头 | 表头 |
| ------ | ------ |
| 内容 | 内容 |
| 内容 | 内容 |
示例:
| 公司 | 坐标 | 创始人 |
| ------ | ------: | :------: |
| 腾讯 | 深圳 | Pony Ma |
| 阿里 | 杭州 | Jack Ma |
效果:
3. 注释
所谓注释,也可以说是草稿,就是不希望显示出来给别人看到的东西。这样吐槽、心情和一些不成熟的想法都可以以这种方式记录。等你时间充裕,好好整理补充一下这些东西,就可以公开发表出来了。
注意⚠️: 如果是换行写的话,前面有四个空格。
语法:
[^_^]: 需要注释的内容
[>_<]: 需要注释的内容
[>_>]: 需要注释的内容
[·-·]: 需要注释的内容
[@_@]: 需要注释的内容
示例:
[^_^]:
这是草稿,仅作者可见,发表出来的文章里看不到。
这是草稿
[>_<]: 这是草稿
效果:
略。界面上啥也不会显示。
本文尚未提到的语法,基本也是平时很难用到的语法,有时间再整理。
未完待续....