Markdown入门指南

Posted 2020-12-31 selier

目录

• 导语
• 一、认识Markdown
  • 使用Markdown的优点
• 二、Markdown 语法
  • 标题
  • 列表
  • 引用
  • 图片与链接
  • 粗体与斜体
  • 表格
  • 代码框
  • 其它
    • 分割线
    • 索引超链
    • 注释
    • 　转义字符
    • 段落缩进(空格)
    • 字体、字号、颜色

导语

Markdown 是一种轻量级的「标记语言」，它的优点很多，目前也被越来越多的写作爱好者，撰稿者广泛使用。看到这里请不要被「标记」、「语言」所迷惑，Markdown 的语法十分简单。常用的标记符号也不超过十个，这种相对于更为复杂的 html 标记语言来说，Markdown 可谓是十分轻量的，学习成本也不需要太多，且一旦熟悉这种语法规则，会有一劳永逸的效果。

• 创始人 John Gruber 的 Markdown 语法说明

• Markdown 中文版语法说明

一、认识Markdown

在刚才的导语里提到，Markdown 是一种用来写作的轻量级「标记语言」，它用简洁的语法代替排版，而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字，用「标记」语法，来代替常见的排版格式。例如此文从内容到格式，甚至插图，键盘就可以通通搞定了。目前来看，支持 Markdown 语法的编辑器有很多，包括很多网站（例如简书）也支持了 Markdown 的文字录入。Markdown 从写作到完成，导出格式随心所欲，你可以导出 HTML 格式的文件用来网站发布，也可以十分方便的导出 PDF 格式，这种格式写出的简历更能得到 HR 的好感。甚至可以利用 CloudApp 这种云服务工具直接上传至网页用来分享你的文章，全球最大的轻博客平台 Tumblr，也支持 Mou 这类 Markdown 工具的直接上传。

使用Markdown的优点

• 专注你的文字内容而不是排版样式，安心写作
• 轻松的导出 HTML、PDF 和本身的 .md 文件。
• 纯文本内容，兼容所有的文本编辑器与字处理软件。
• 随时修改你的文章版本，不必像字处理软件生成若干文件版本导致混乱。
• 可读、直观、学习成本低。

二、Markdown 语法

标题

标题是每篇文章都需要也是最常用的格式，在 Markdown 中，如果一段文字被定义为标题，只要在这段文字前加 # 号即可。

一级标题： #

二级标题 ：##

三级标题： ###

以此类推，总共 六 级标题，建议在 “ # ” 号后加一个空格，这是最标准的 Markdown 语法。

另一种标题

  大标题
  ===
  小标题
  ---

列表

熟悉 HTML 的同学肯定知道有序列表与无序列表的区别，在 Markdown 下，列表的显示只需要在文字前加上 - 或 * 即可变为无序列表，有序列表则直接在文字前加 1. 2. 3. 符号要和文字之间加上一个字符的空格。

  - 列表一
  - 列表二
  * 列表三
  * 列表四
  1. 列表五
  2. 列表六

生成样式：

• 列表一
• 列表二
• 列表三
• 列表四

1. 列表五
2. 列表六

嵌套列表

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

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

生成样式：

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

引用

如果你需要引用一小段别外的句子，那么就要用引用的格式

> 例如这样
>> 引用中的引用
>>> 很多引用

生成样式：

例如这样

---

例如这样

引用中的引用

很多引用

只需要在文本前加入 > 这种尖括号（大于号）即可

图片与链接

插入链接与插入图片的语法很像，区别在一个 !号

图片为：![Tooltips](URL)

链接为：[Tooltips](URL)

  [百度](http://www.baidu.com "百度一下")

Tooltips可省略

生成样式：

百度

自动链接

  <http://www.baidu.com>
  <[email protected]>

生成样式：

http://www.baidu.com

[email protected]

粗体与斜体

Markdown 的粗体和斜体也非常简单，用两个 * 包含一段文本就是粗体的语法，用一个 * 包含一段文本就是斜体的语法。

例如：

**这里是粗体** *这里是斜体*

生成样式：

这里是粗体 这里是斜体

表格

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

这种语法生成的表格如下：

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

表格设置表头居中

|:--|--:| 其中冒号表示表格需要居中的方向

注：不同平台的解释器会有不同影响，比如:--: 有可能也会影响表格

代码框

单行代码：使用一个 “`”， 将首尾包围起来。位置在键盘ESC的下面一个键
多行代码：使用三个 ` 将首尾行包围起来。在第一行后指定编程语言，也可以不指定

需要注意的是：写代码框的前一行最好为空白行，否则无法生成相应的样式

使用 tab 键即可缩进。

如：

 ‘这是一行代码‘
 

---

 ```这是一段代码```
 

---

```java
       public void main(String[] args){
            System.out.println("Hello world!");
       }
```

生成样式：

这是一行代码

这是一段代码

public void main(String[] args){
  System.out.println("Hello world!");
}

另一种段落代码：每行文字前加4个空格或者1个Tab

val s = "hello Markdown"
println( s )
val s = "hello Markdown"
println( s )

注：在创建表格时不使用空格或者Tab做开关，否则会解析成段落代码

Markdown支持的语言

名称	关键字
AppleScript	applescript
ActionScript 3.0	actionscript3 , as3
Shell	bash , shell
ColdFusion	coldfusion , cf
C	cpp , c
C#	c# , c-sharp , csharp
CSS	css
Delphi	delphi , pascal , pas
diff&patch	diff patch
Erlang	erl , erlang
Groovy	groovy
Java	java
JavaFX	jfx , javafx
javascript	js , jscript , javascript
Perl	perl , pl , Perl
php	php
text	text , plain
Python	py , python
Ruby	ruby , rails , ror , rb
SASS&SCSS	sass , scss
Scala	scala
SQL	sql
Visual Basic	vb , vbnet
XML	xml , xhtml , xslt , html
Objective C	objc , obj-c
F#	f# f-sharp , fsharp
R	r , s , splus
matlab	matlab
swift	swift
GO	go , golang

其它

分割线

在一行中用三个以上的星号(*)、减号(-)、下划线(_)来建立一个分隔线

除空格外行内不能有其他字符

(除第一个符号的左侧最多添加三个空格外）三个相同符号两侧可以添加任意多个空格。

---
___
***

生成样式：

---

---

---

索引超链

索引，1 可以是任意字符

  [百度][1]
  [1]：http://www.baidu.com/

百度

注释

  <!-- 注释 -->

　转义字符

Markdown中的转义字符为，转义的有：

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

段落缩进(空格)

 或 
 或 
 或 
 

这是一句话?或?这是一句话

这是一句话?或?这是一句话

这是一句话 或 这是一句话

?这是一句话

字体、字号、颜色

  <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>

我是黑体字
我是微软雅黑
我是华文彩云
黑体
null
gray

使用总结：

1. Markdown 是一个学习成本低的技术。学会它你可以用它记录任何数据
2. Markdown 支持html的标签，在记录过程中，如果这些标签满足不了你，你也可以使用html
3. 这些知识点不一定都会使用到，一般只要用到常用的几个，如果忘记了可以再看看教程。