MarkDown语法记录，还在用word，txt编写项目文档吗？

开始之前

是不是在github上看项目的时候第一眼就要看项目介绍？ 是不是经常在某些项目的代码里面看到一个README.MD文档 却不知道怎么写？

你是不是不知道，反正我是的。

作为一个程序员，可能写了几年之后都会或多或少的需要写一份可以帮助别人快速了解你的项目的文档，这个时候如果你用txt或者word来写 ，是不是有点不够逼格，又或排版略显麻烦？

那么它来了 —— MarkDown

Markdown是一种轻量级的标记语言，使用极为简单的语法就可以实现 段落，文字字体，超链接，图片，代码块，表格 等等等 模块。非常的简单实用帮助我们快速编辑一个HTML文档。

---

快速开始

• 标题

标题的实用很常见，像html的“H”标签一样 h1-h6表达标题字体大小 ，同理，在 md中使用 “#” 来表达标题级别，通过数量来决定标题大小 ，1个“#”即代表 1级标题，即最大的标题。

只需要在想要作为标题的文字前加对应的“#”数量即可以完成。（注意：“#”号的最后，文字前需要加一个空格 这个最好是加上 因为有一些编辑器可能不加无法识别 ）

一级标题

# 一级标题

二级标题

## 二级标题

三级标题

###三级标题

四级标题

#### 四级标题

五级标题

##### 五级标题

六级标题

###### 六级标题

是不是很简单？

• 字体

字体是文章很重要的一部分，有些需要读者重点了解的内容，只需要将字体像这样 加粗 ，变斜，或者又粗又斜，又或者修改文档增加注释废弃的代码。

如此表达是不是很清晰？

敲黑板

粗体

普通：粗体

加粗：粗体 **粗体**

斜体

普通：斜体

变斜：斜体 *斜体*

又粗又斜

普通：又粗又斜

粗斜：又粗又斜 ***又粗又斜***

删除线 废弃线

普通：删除，废弃

删除，废弃：删除，废弃 ~~删除，废弃~~

• 引用

有时候 需要引用别的文章/句式/代码等 可以使用引用块 表达

人到中年不得已 保温杯里泡枸杞 -某位程序员

>人到中年不得已 保温杯里泡枸杞 -某位程序员

只需要在引用之前 加一个“>”即可

• 分割线

博客的md编辑器好像不太行 应该是对分割线做了一些东西，显示不出来。用法如下

---

***

两种方式都可以实现分割线。

• 图片

图片有两种形式: 本地图片 网络图片

写法实际是一样的

[图片上传失败...(image-a4462c-1602734880148)]

![网络图片](https://ss2.bdstatic.com/70cFvnSh_Q1YnxGkpoWK1HF6hhy/it/u=768863205,4008355431&fm=15&gp=0.jpg)

![图片描述](图片url)

如果是本地图片 图片url替换成为图片本地路径就可以。

• 超链接

这里会跳转到非常神奇的一个地方，在这里我们可以遨游互联网

[这里会跳转到非常神奇的一个地方，在这里我们可以遨游互联网](https://www.baidu.com)

[链接文字](链接)

没错，超链接与加载图片的写法只差了一个“!”

• 列表

列表其实是一个非常常用的功能 ，列表的排版会让文章调理更清晰，更方便划清重点。

• A
• B
• C

只需要在内容前加“- ”（减号+空格）即可.

- A
- B
- C

• 表格

表格我就不多说了吧？直接上用法:

姓名	性别	年龄	专业
二狗子	男	28	android开发工程师
小美	女	18	python开发工程师
铁柱	未知	30	java开发工程师

姓名|性别|年龄|专业
--|--|--|--
二狗子|男|28|android开发工程师
小美|女|18|python开发工程师
铁柱|未知|30|java开发工程师

这也太简单了吧？？？

• 代码块

public static void main(){
  Log.d(TAG,"hello,md");
}

代码块用 ` 三个放在开头 三个放在结尾，代码放在中间即可。

像这样：

```

public static void main(){

Log.d(TAG,"hello,md");

}

```

• 高级进阶

感谢小伙伴读到了这里，下面我们来介绍一下高级进阶用法

高级的用法我也是在网上通过其他大神或者教学网站整理而来，如果有侵权行为，请私信我 ，我这面立即就会整改

• 转义

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

例如：

文本加粗

** 正常显示星号 **

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

• 公式

数学公式这块 我还有点没太弄明白 等我弄明白了 我再回头来分享给大家。

工具

工具其实在线的就有很多，能直接预览你编辑的MD 。我个人更偏向使用本地的工具，编辑预览起来更方便，功能也更强大一些。

在这里给大家推荐一个练习或者编辑使用的编辑器：

Typora-MD编辑器

这应该是我用过的最好用的编辑器了，大家可以下载一下 平时练习使用。

我是一名android开发者，目前想考虑转一下方向去做服务端架构和代码编写，目前正在从头开始学习java。

这个博客是刚刚注册的， 哪怕虽然我已经做了8年的程序员，但一直都在索取，现在希望在学习的过程中，记录下来问题和经验，来帮助更多需要帮助的人。