Markdown写作规范参考

Posted by cwen 2015-11-27

之前转发了GC的一篇介绍markdown的写作语法以及如何在页面里引用markdown的文章,写的已经很全面了,我在此就不做多余的介绍了,有兴趣可以自行查阅

Markdown-入门指南及网站整合 .其实每个人都有自己的写作规范,在此我只是简单的说说我的markdown写作规范,以供大家参考.

1. 如何使用加粗

markdown提供两种方法
**加粗** 或是 __加粗__

但是我个人推荐使用 **加粗**
推荐理由:喜欢就好(但是要统一用法,最好别再一篇文章里混用,这样文章会显得很乱,不易于以后修改)

2. 如何使用斜体  

markdown提供两种方法
*加斜* 或是 _加斜_

但是我个人推荐使用 *加斜*
推荐理由:同上

3. 如何使用加粗并斜体

加粗和斜体的组合应该又四种
***加粗并斜体*****_加粗并斜体_**__*加粗并斜体*_____加粗并斜体___
如果我们在一篇文章里混用这四种,那我们在修改的时候可想而知,呵呵....

个人推荐:***加粗并斜体***
推荐理由:既然我们已经选择的单加粗以及单斜体的用法,那我们就继续任性到底呗....

4. 如何使用标题

h1 两种方式

# 这是文章h1标题
这也是文章h1标题
=========

h2两种方式

## 这是文章h2标题
这是文章h2标题
-------

h3

### h3

h4, h5, h6 ....

个人推荐: 全部都用 # 这个系列
推荐理由: 喜欢就好(但是要统一用法,最好别再一篇文章里混用,这样文章会显得很乱,不易于以后修改)

5. 如何使用连接

markdown 提供两种连接方法
1. 普通连接: [显示文本](连接地址) 图像连接: ![](图像连接地址)
2. 普通连接: [显示文本][连接标签]

个人推荐: 段落内使用 [显示文本][连接标签] ,左右各留一空格,
不推荐使用 [显示文本](连接地址)
推荐理由: [显示文本](连接地址) 容易使段落看起来臃肿 ,除非一些特殊情况,具体分析.

6. 连接的URL放在哪?

比如你有这样一个段落:

这是一个带有[超链接][link-to]的段落。
你的 [link-to]: url 放在哪?紧跟段落后面,还是一大章节后面,还是全文最后?

个人推荐: 放在章节后面,比如放在下一个四级标题前
推荐理由: 个人绝的好像看起来更爽一点,文本更整洁一点.

7. 如何使用空格、空行、分隔符

空格: 推荐在各级标题 ### 以及列表 *+-1. 的后边跟一空格 ,中英文之间加空格,正文与专有名词之间留空格
空行: 推荐在各级标题 ### 前多留几个空行,### 后留一空行
分隔符: 在应该分割的地方,Markdown 支持用一个空行加 ---(可以更多个-) 形成一个<hr>(分割符)

推荐理由: 个人感觉更整洁

8. 最后总结

形成自己的Markdown写作规范, 主要保持、规范、统一、整洁, 便于以后修改.

这篇文章仅代表作者个人观点,仅提供参考
其实我的写作规范受这篇文章的影响 Markdown 写作规范参考 参考了其部分内容 (不是有意参考实在是这已变成了我自己的写作规范)