Markdown基本用法

背景

刚开始接触Markdown是由于经常逛Github的原因，Github的开源项目中一般都会有README.md这个文件，该文件就是用Markdown语法写的，很明显可以看出用了该语法后，文档看起来会给人特别的简洁、舒服的感觉，所以至那后我便开始喜欢上了用Markdown写文档、博客之类的了。

简介

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。 —— [ 维基百科 ]

Markdown 语法在 2004 年正式问世，是一种常用的计算机语法，目的在于帮助与文字、代码相关的工作者在不需要进行复杂排版的条件下直接使用标记语言来完成 HTML 排版。Markdown 得到了包括 GitHub、Reddit 等在内的主流互联网技术和内容平台的支持。
但由于 Markdown 语言自从创立以来就没有进行过大的版本更新，而各大主要的使用者都对其语法的部分细节进行过小的修改，导致第三方版本千变万化，语法存在一定程度碎片化的情况。

• 优点
  • 纯文本，兼容性强，支持各类文本编辑器。
  • 格式转换方便，Markdown的文本可以轻松转换为HTML、PDF格式等。
  • 结构清晰，排版美观，易读性强。
  • 支持Markdown语法的编辑器有很多，部分网站也支持，如：简书、CSDN等
• 缺点
  • 无法进行复杂的排版，这一点不如Word文档

语法

1.目录/锚点

语法：

- [标题名称](#锚点标题名称)

锚点标题名称需注意：

• #后不能加空格
• 英文全部必须小写
• 空格替换成-
• .直接去掉

推荐使用相对路径，不会因为项目搬迁而失效。

2.标题

标题目前最大支持6个级别，大于6个’#‘则无效，多个’#‘分别对应多少个级别。其中’#’ 和标题必须要用空格分开，不能连接在一起。

# 一级标题  <!-- omit in toc -->
## 二级标题  <!-- omit in toc -->
### 三级标题  <!-- omit in toc -->
#### 四级标题  <!-- omit in toc -->
##### 五级标题  <!-- omit in toc -->
###### 六级标题  <!-- omit in toc -->

3.文本

3.1 普通文本

大家好我是小白！

3.2 文本块

在文本的开头加上1个Tab或者4个空格即可
离思五首·其四

【作者】元稹 【朝代】唐 

曾经沧海难为水，

除却巫山不是云。

取次花丛懒回顾，

半缘修道半缘君。

3.3 换行

一行结束时输入两个空格

4.字体

4.1 斜体

斜体1
斜体2

4.2 粗体

粗体1
粗体2

4.3 粗斜体

粗斜体1
粗斜体2

4.4 删除线

删除线

####  下划线（有道支持）

++ 下划线 ++  

####  标记（有道支持）

== 地方 ==

5.分割线

三个及以上的’-’,’*’,’_'都可以生成分割线。

---

---

6.列表

6.1 无序列表

无序列表可以使用+、-、*作为开头标记：

• 特点
• 功能
• 资料

• 特点
• 功能
• 资料

• 特点
• 功能
• 资料

6.2 多级无序列表

• 特点
  • 功能
    • 资料

6.3 有序列表

有序列表则使用数字接着一个英文句点：

1. 步骤一
2. 步骤二
3. 步骤三

6.4 多级有序列表

1. 步骤一
   1. 步骤二
      1. 步骤二

6.5 待办事项

• 待办事项1
• 待办事项2

6.6 多级待办事项

• 待办事项1
  • 待办事项2
    • 待办事项2

7.代码块

https://help.github.com/en/articles/creating-and-highlighting-code-blocks

alert('Hello World');

public static void main(String[]args){} //Java

int main(int argc, char *argv[]) //C

echo "hello GitHub" #Bash

document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //Javascript

string &operator+(const string& A,const string& B) //cpp

8.表格

• 写法1，开头结尾添加’|’：

表头	表头	表头
单元	单元	单元

• 写法2，开头结尾都不添加’|’：

表头	表头	表头
单元	单元	单元

• 写法3，可多添加’-’：

表头	表头	表头
单元	单元	单元

其中’-'至少需要一个，为了对齐，可多加了几个。

• 对齐

默认对齐	左对齐	居中对齐	右对齐
-	:-	:-:	-:

:表示默认左对齐，:-表示左对齐，:-:表示居中对齐，-:表示右对齐，-数目至少需要一个，第二行的对齐方式必须要有，否则不是表格形式。

• 混合表格

图片	斜体	粗体	粗斜体	删除线	顶部
	单元	粗体	粗斜体	删除线	顶部

9.图片

• 无提示

• 鼠标悬浮提示

Github仓库里的图片

方式一：https://raw.githubusercontent.com/用户名/仓库名/分支名/文件夹路径/图片
https://raw.githubusercontent.com/Brainbg/CloudPic/master/Markdown/github_icon.png


方式二：https://github.com/用户名/仓库名/raw/分支名/文件夹路径/图片
Github图片原链接：https://github.com/Brainbg/CloudPic/blob/master/Markdown/github_icon.png
把blob改成raw
https://github.com/Brainbg/CloudPic/raw/master/Markdown/github_icon.png

本地图片

10.超链接

百度
百度

11.引用

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

这是一个标题。

1. 这是第一行列表项。
2. 这是第二行列表项。

给出一些例子代码：

return shell_exec("echo $input | $markdown_script");

diff

+ dfd
+ dfd
- dfd
- dfdf
+ dfdf
- dfdf
- dfdf

### 绘图（有道云笔记支持）
#### 流程图
#### 序列图
#### 甘特图
#### 数学公式 

常用的Markdown 编辑器

• OSX
  • VSCode
  • Atom
  • Byword
  • Mou
  • Typora
  • MacDown
  • RStudio
• Linux
  • VSCode
  • Atom
  • Typora
  • ReText
  • UberWriter
  • RStudio
• Windows
  • VSCode
  • 有道云笔记
  • Atom
  • CuteMarkEd
  • MarkdownPad2
  • Miu
  • Typora
  • RStudio
• iOS
  • Byword
• Android
  • 有道云笔记
  • 印象笔记
• 浏览器插件
  • MaDo (Chrome)
  • Marxico（Chrome）
• 高级应用
  • Sublime Text 3 + MarkdownEditing / 教程 [1]

参考

Github中的图片

作者：Brainbg(白雨)
GitHub：https://github.com/Brainbg
博客：https://www.brainbg.com/
简书：https://www.jianshu.com/u/94518ede7100
CSDN：https://blog.csdn.net/u014720022