工欲善必先利器:Markdown基础用法

引言

 前几天换了工作,大约是996,在完成工作后决定能静下心来做一些有意义的事,准备将我入行4年多来(写在2019年)的收获进行整理。这篇文章将是我小菜鸟的第一篇文章。

准备工作:了解下载Markdown

1. 什么是Markdown

Markdown

 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

 的书写就是使用的Markdown语法。

2. Mac OS下的Markdown编辑器

 我使用的Markdown编辑器名字叫“MacDown”,是一款免费软件,附上下载地址
MarkDown下载地址

直接开整:Markdown语法

1. 文本编辑

 就是最常见的文本输入,不过要注意“空格”、“换行”,因为Markdown主要针对的是英文输入,所以对于我们习惯首行缩进并不友好,所幸Markdown对于HTML标签也是支持的所以我们可以用来表示全方大的空白,或者使用表示半方大的空白;

正常文字
 半方大的空白
 全方大的空白

正常文字
 半方大的空白
 全方大的空白
正常文字

 换行有两种方式,第一种就是直接敲出回车,另一种就是使用标签

第一行
第二行

第一行
第二行

2. 文字属性

 文字有时候需要进行加粗倾斜斜体加粗删除线、字符转义则是前面加\
**加粗**
*倾斜*
***斜体加粗***
~~删除线~~
\*星号\*

*星号*

3. 标题

 标题也很简单,标识符是#,1号标题是#,2号是##,以此类推,最小应该是6号######
#1号标题
##2号标题
###3号标题
####4号标题
#####5号标题
######6号标题
#######7号没了

1号标题

2号标题

3号标题

4号标题

5号标题
6号标题

#######7号没了

4. 项目符号与编号

 相对应Word中的项目符号 和编号1.注意符号和后面文字之间有空格
- 哈哈
+ 哈哈
* 哈哈
1. 哈哈

  • 哈哈
  • 哈哈
  • 哈哈
  1. 哈哈

5. 引用

 引用就是你引用其他内容,当然也可以当做框出一块作为块单元使用。引用分两种,“多行引用”和“嵌套引用”,多行引用只需要在引用前加>,下一行有内容也会被引用,不想继续引用就要回车和上一行进行切割;
>多行引用
继续引用

不引用

多行引用
继续引用

不引用

 如果要进行引用内换行继续引用可以使用标签

>引用

换行引用

引用

换行引用

 嵌套引用,就是再次引用另一个进行缩进,使用多个>标识,层级越里,>个数越多,应该是可以嵌套很多层

第一层引用

第二层引用

第三层

.....

6. 代码和语法高亮

 单行代码最便捷使用用` `,多行可以使用并且代码自动高亮``` ```
`UIView *view = [[UIView alloc] init];`
```
UIView *view = [[UIView alloc] init];
[self.view addSubview:view];
```

UIView *view = [[UIView alloc] init];

 UIView *view = [[UIView alloc] init];
 [self.view addSubview:view];

7. 超链接

 超链接就是可以链接跳转的文字例如百度网
[百度网](https://www.baidu.com)

8. 图片

 插入图片的语法和超链接的语法基本一致,只是在最前面多一个 !。
![琉璃](http://upload-images.jianshu.io/upload_images/2120646-ef4e88ce41acbdee.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

工欲善必先利器:Markdown基础用法_第1张图片
琉璃

目前我没找到一个用语法来改变图片大小的方法(在上有效),可以教教我这个小菜鸡

9. 表格

 表格是我觉得Markdown最好用的语法了。使用|来分隔不同的单元格,使用 -来分隔表头和其他行:
参数名| 参数类型| 注释
---| ---| ---
Name| String| 名字
Age| Int| 年龄

参数名 参数类型 注释
Name String 名字
Age Int 年龄

是不是这种方式写接口文档快乐很多,对齐方式也是不同,另外表格还可以添加超链接和图片,以及文字特殊编辑

  • 左对齐 :---
  • 居中对齐 :--:
  • 右对齐 --:

左| 中| 右
:---| :---: | ---:
1|1|1
111|1111|111

1 1 1
百度
工欲善必先利器:Markdown基础用法_第2张图片
琉璃
111

你可能感兴趣的:(工欲善必先利器:Markdown基础用法)