淡定哥头像

技术文档

MarkDown入门使用手册

MarkDown入门使用手册

1. MarkDown简介

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

MarkDown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持MarkDown。完全采用MarkDown编辑器的博客平台有Ghost和Typecho。

用于编写说明文档,并且以“README.MD”的文件名保存在软件的目录下面。

2. MarkDown 编辑器

Sublime是一个亮骚的文本编辑器,而且是跨三大平台,而markdown是一门标记语法,Sublime对于记录markdown真是神器。

  1. Sublime text 中 Package Control 的安装与使用方法

  2. Sublime安装markdown preview和MarkdownEditing

3. MarkDown语法

3.1 标题

1到#6 表示标题1到6

标题一

标题二

标题三

标题四

标题五
标题六

MarkDown示例代码:

# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六


3.2 源代码

使用三个回勾号```表示代码

Java代码:

public class HelloWorld {
  public static void main(String[] args) {
    System.out.println("Hello, World!");
  }
}


MarkDown示例代码:

```
public class HelloWorld {
  public static void main(String[] args) {
    System.out.println("Hello, World!");
  }
}
```

Javascript代码:

var obj = document.getElementById("msg");
obj.innerHTML="提示信息";


MarkDown示例代码:

```
var obj = document.getElementById("msg");
obj.innerHTML="提示信息";
```

3.3 引用

使用 > 表示引用, >> 表示引用里面再套一层引用,依次类推。

这是一级引用

第二行区块

这是二级引用

第二行区块

这是三级引用

第二行区块

MarkDown示例代码:

> 这是一级引用
> 
> 第二行区块

>>这是二级引用
>>
>>第二行区块

>>> 这是三级引用
>>> 
>>> 第二行区块


3.4 文本样式

3.4.1 加粗

*包括 表示加粗
示例:
该部分加粗
*效果。

MarkDown示例代码:

示例:**该部分加粗**效果。


3.4.2 斜体

*包括 表示斜体
示例:
斜体*效果。

MarkDown示例代码:

示例:*斜体*效果。


3.4.3 加粗加斜体

*加粗加斜体
示例:
斜体
*效果。

MarkDown示例代码:

示例:***斜体***效果。


3.4.4 删除线

~~ 表示删除线
示例:这是一条删除线

MarkDown示例代码:

示例:~~这是一条删除线~~。


3.4.5 高亮

高亮 :text
示例:这是高亮。

MarkDown示例代码:

示例:这是`高亮`。


3.5 列表

3.5.1 无序列表 (用 *、+、- 表示 )

  • 第一个
  • 第二个

  • 第一个

  • 第二个

  • 第一个

  • 第二个

MarkDown示例代码:

* 第一个
* 第二个

+ 第一个
+ 第二个

- 第一个
- 第二个


3.5.2 有序列表 (用数字+点号表示)

  1. 第一个
  2. 第二个
  3. 第三个

MarkDown示例代码:

1. 第一个
1. 第二个
1. 第三个


3.5.3 多级列表(用加号+减号+Tab键组合表示)

  • 列1
  • 列2
    • 列2.1
    • 列2.2
      • 列2.2.1
      • 列2.2.2
    • 列2.3
      • 列2.3.1
      • 列2.3.2

MarkDown示例代码:

+ 列1
+ 列2
    - 列2.1
    - 列2.2
        + 列2.2.1
        + 列2.2.2
    - 列2.3
        + 列2.3.1
        + 列2.3.2


补充说明:

如果段的开头就是数字+点号,则在点号之前加\进行转义;
如果想在列表的单项内使用代码,则代码之前必须是 2个Tab 或者 8个空格 ;
如果想在列表的单项内使用区块,则>之前必须是 1个Tab 或者 4个空格 ,
并且前后各一个空行

3.6 链接

链接分为俩种, 行内链接 和 参考链接 。

3.6.1 行内链接

这是“淡定哥”博客

MarkDown示例代码:

这是[“淡定哥”博客](http://ian.wang/ "“淡定哥”博客")。


3.6.2 参考链接

这是“淡定哥”博客

MarkDown示例代码:

这是[“淡定哥”博客][1]。
[1]: http://ian.wang/ "“淡定哥”博客"


3.6.3 隐式链接功能

这是“淡定哥”博客

MarkDown示例代码:

这是[“淡定哥”博客][]。
[“淡定哥”博客]: http://ian.wang/ "“淡定哥”博客"


3.6.4 自动链接

http://ian.wang/ 25093485@qq.com
链接对网址或者电子邮箱都有效。

MarkDown示例代码:

 <25093485@qq.com>


3.7 图片

图片的表示方法和链接的表示方法一样,也有俩种。分为 行内形似 和 参考形式。

3.7.1 行内形式图片

下面是淡定哥的头像:
淡定哥

MarkDown示例代码:

![淡定哥](http://ian.wang/f/2014/12/12/103224QvNjs.jpg "淡定哥")


3.7.2 参考形式图片

下面是淡定哥的头像:
淡定哥

MarkDown示例代码:

![淡定哥][Ian Wang]
[Ian Wang]: http://ian.wang/f/2014/12/12/103224QvNjs.jpg "淡定哥"


补充说明:

图片的表示方法和链接的表示方法大致相同,只是前面多了一个感叹号。
链接后面的文字,转化成HTML标识title属性。该属性可选。

3.8 分割线

三个以上的*、-、_ 表示一个分割线。




MarkDown示例代码:

****
----
____


补充说明:

四个*很类似加粗,为了防止歧义或者误解,个人还是建议使用----,简单明了。

3.9 反斜杠转义字符

使用 \ 表示反斜杠。在你不想显示MarkDown标记时可以使用反斜杠。
*这里不会显示斜体*

MarkDown示例代码:

\*这里不会显示斜体\*


3.10 表格

表格具体使用方式请看示例。
------: 为右对齐。
:------ 为左对齐。
:------: 为居中对齐。
------- 为使用默认居中对齐。

序号 用户名 昵称 角色
1 Ian 淡定哥 管理员
2 Tom 汤姆 会员

MarkDown示例代码:

|         序号    |    用户名    |    昵称    |    角色    |
|    ------: |    :-------:    |    :---------   |    ------    |
|    1    |    Ian    |    淡定哥    |    管理员    |
|    2    |    Tom    |    汤姆    |   会员  |


3.11 注脚

使用 [^footer] 表示注脚。
示例:

MarkDown示例代码:

[^footer1]: 这是一个测试,用来阐释注脚。



  1. 这是一个测试,用来阐释注脚。 

分享到: 

* 发表评论:
Top