MarkDown v1.0

1.1 全局规范

  • MarkDown 文件使用‘.md’结尾 （小写字母)

格式规范

标题结构格式

1.标题与紧贴的’上下正文‘使用’1整行换行‘隔开
2.’#’号和文字之间’一个空格’连接
3.标题层级最多六级 ‘#’到’######’

加强和强调规范

一般统一使用第一种

1
2
*emphasize*
_emphasize_

使用’~~’给文字添加删除线

1
~~strikethrough~~

代码块规范

  • 行内代码使用’一对波浪号’如：hello world!
  • 块级代码使用’三个波浪号’或’整体四空格缩进’，且上下均用整行隔开，如下：
1
2
3
<?php
    echo '看源码之三个波浪号';
?>
<?php
    echo '看源码之四空格缩进';
?>

列表写法

  • 列号’1.’或者’*’后内容用空格隔开
  • 列表块前后’整行隔开’ 如下：
1
2
3
4
5
6
1. Windows  
2. Mac
3. iOS
    * iPhone
    * iPad
4. Android

实际预览：

  1. Windows
  2. Mac
  3. iOS
    • iPhone
    • iPad
  4. Android
1
2
3
4
5
6
* Windows  
*  Mac
*  iOS
*  Android
    1. v3.2
    2. v4.1

实际预览：

  • Windows
  • Mac
  • iOS
  • Android
    1. v3.2
    2. v4.1

其他标签规范

链接和email

Inline：

1
An [example](http://url.com/ "title")

实现效果：
An example

引用样式标签（titles are optional）:

An [example][id].Then,anywhere
else in the doc,define the link:

[id]:http://example.com/ "title"

Email:

1
An email <example@example.com> link.

插图
Inline(titles are optional)：

1
![alt text](/path/img.jpg "title")

引用式插图：

![alt text][id]
[id]:/url/to/img.jpg "title"

引用块及嵌套

Email-style angle brackets
are used for blockquotes.

And, they can be nested.

Headers in blockquotes

  • You can quote a list.
  • Etc.

内联代码

<code> 段落中的用法

也可以 `代码中包含波浪号`.
代码块

Indent every line of a code block by at least 4 spaces or 1 tab.
代码的每行都最少用4个空格或者一个制表符(tab)

我是普通文本块

我是一个预格式化的
代码块.

水平分割线
三个连字符-:

表格规范

一个简单的表格看起来如下：

第一个头部 第二个头部 第三个头部
内容格子 内容格子 内容格子
内容格子 内容格子 内容格子

每列的对齐可以通过在分割线上添加冒号来实现：

第一个头部 第二个头部 第三个头部
左对齐 居中 右对齐
左对齐 居中 右对齐

页内锚标记

附：参考 Hello-World.md 源码，注意换行的使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Hello-World

这是一个范例文件格式
我是普通换行

## 我是<h2>标题

我是`<h2>`的内容

## 我是<h3>标题

* Windows  
*  Mac
*  iOS
*  Android