add 文章书写规范及要求.md

文章书写规范及要求.md

@@ -0,0 +1,331 @@
+---
+title: 文章书写规范及要求
+author: 高春明
+toc: true
+date: 2016-08-18 14:00:00
+category: 
+ - 规范
+tag: 
+ - 规范
+ - hexo文章
+comments: false
+---
+
+# 文章书写规范及要求
+
+## 概述
+
+公司blog采用MarkDown格式编写。
+<!--more-->
+编写时注意“标签”与“正文”之间应该有一个空格，如：
+
+>  文章头信息的标签title:与“文章标题”应有一个空格——**title: 文章书写规范及要求**
+
+> 正文标题的标签\##与“标题”之间应有一个空格——**\## 概述**
+
+文章编写的其他规范细节请继续阅读。
+
+## 文章路径
+
+文章写完后存放在"source/_posts/"文件夹下
+
+## 文件命名
+
+文件命名遵循“yyyy-MM-DD-title.md”格式。如果文章中用到图片，则在"source/_posts/"下新建与文档同名的文件夹如：“yyyy-MM-DD-title”，并把图片存放在该文件夹下
+
+## 文章头信息
+
+在文章的开头添加头信息，格式及内容：
+
+```
+---
+title: 文章标题
+author: 作者
+toc: 是否生成目录（true或false）
+date: 文档日期（yyyy-MM-dd HH:mm:ss）
+category: 分类信息，按照要求分类，不能随便分类
+ - 规范（分类1）
+tag: 标签，可自定义文章的标签
+ - 规范（标签1）
+ - hexo文章（标签2）
+comments: 是否开启文章的评论功能（true或false）
+---
+```
+
+## 标题
+
+文章最多采用“三级”标题：
+
+> 一级标题 ： \#＋空格＋标题
+
+> 二级标题 ： \##＋空格＋标题
+
+> 三级标题 ： \###＋空格＋标题
+
+## 标签插件
+
+标签插件和 Front-matter 中的标签不同，它们是用于在文章中快速插入特定内容的插件。
+
+**引用块**
+
+在文章中插入引言，可包含作者、来源和标题。
+
+**别号：** quote
+
+```
+{% blockquote [author[, source]] [link] [source_link_title] %}
+content
+{% endblockquote %}
+```
+
+**样例**
+
+没有提供参数，则只输出普通的 blockquote
+
+```
+{% blockquote %}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque hendrerit lacus ut purus iaculis feugiat. Sed nec tempor elit, quis aliquam neque. Curabitur sed diam eget dolor fermentum semper at eu lorem.
+{% endblockquote %}
+```
+{% blockquote %}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque hendrerit lacus ut purus iaculis feugiat. Sed nec tempor elit, quis aliquam neque. Curabitur sed diam eget dolor fermentum semper at eu lorem.
+{% endblockquote %}
+
+引用书上的句子
+
+```
+{% blockquote David Levithan, Wide Awake %}
+Do not just seek happiness for yourself. Seek happiness for all. Through kindness. Through mercy.
+{% endblockquote %}
+```
+
+{% blockquote David Levithan, Wide Awake %}
+Do not just seek happiness for yourself. Seek happiness for all. Through kindness. Through mercy.
+{% endblockquote %}
+
+引用 Twitter
+
+```
+{% blockquote @DevDocs https://twitter.com/devdocs/status/356095192085962752 %}
+NEW: DevDocs now comes with syntax highlighting. http://devdocs.io
+{% endblockquote %}
+```
+
+{% blockquote @DevDocs https://twitter.com/devdocs/status/356095192085962752 %}
+NEW: DevDocs now comes with syntax highlighting. http://devdocs.io
+{% endblockquote %}
+
+引用网络上的文章
+
+```
+{% blockquote Seth Godin http://sethgodin.typepad.com/seths_blog/2009/07/welcome-to-island-marketing.html Welcome to Island Marketing %}
+Every interaction is both precious and an opportunity to delight.
+{% endblockquote %}
+```
+
+{% blockquote Seth Godin http://sethgodin.typepad.com/seths_blog/2009/07/welcome-to-island-marketing.html Welcome to Island Marketing %}
+Every interaction is both precious and an opportunity to delight.
+{% endblockquote %}
+
+**代码块**
+
+在文章中插入代码。
+
+别名： code
+
+```
+{% codeblock [title] [lang:language] [url] [link text] %}
+code snippet
+{% endcodeblock %}
+```
+
+**样例**
+
+普通的代码块
+
+```
+{% codeblock %}
+alert('Hello World!');
+{% endcodeblock %}
+```
+
+{% codeblock %}
+alert('Hello World!');
+{% endcodeblock %}
+
+指定语言
+
+```
+{% codeblock lang:objc %}
+[rectangle setX: 10 y: 10 width: 20 height: 20];
+{% endcodeblock %}
+```
+
+{% codeblock lang:objc %}
+[rectangle setX: 10 y: 10 width: 20 height: 20];
+{% endcodeblock %}
+
+附加说明
+
+```
+{% codeblock Array.map %}
+array.map(callback[, thisArg])
+{% endcodeblock %}
+```
+
+{% codeblock Array.map %}
+array.map(callback[, thisArg])
+{% endcodeblock %}
+
+附加说明和网址
+
+```
+{% codeblock _.compact http://underscorejs.org/#compact Underscore.js %}
+_.compact([0, 1, false, 2, '', 3]);
+=> [1, 2, 3]
+{% endcodeblock %}
+```
+
+{% codeblock _.compact http://underscorejs.org/#compact Underscore.js %}
+_.compact([0, 1, false, 2, '', 3]);
+=> [1, 2, 3]
+{% endcodeblock %}
+
+**反引号代码块**
+
+另一种形式的代码块，不同的是它使用三个反引号来包裹。
+
+此处使用三个\`
+
+[language] [title] [url] [link text] code snippet 
+
+此处使用三个\`
+
+**Pull Quote**
+
+在文章中插入 Pull quote。
+
+```
+{% pullquote [class] %}
+content
+{% endpullquote %}
+```
+
+**jsFiddle**
+
+在文章中嵌入 jsFiddle。
+
+```
+{% jsfiddle shorttag [tabs] [skin] [width] [height] %}
+```
+
+**Gist**
+
+在文章中嵌入 Gist。
+
+```
+{% gist gist_id [filename] %}
+```
+
+**iframe**
+
+在文章中插入 iframe。
+
+```
+{% iframe url [width] [height] %}
+```
+
+**Image**
+
+在文章中插入指定大小的图片。
+
+```
+{% img [class names] /path/to/image [width] [height] [title text [alt text]] %}
+——以上方法经验证没有出现想要的效果，可验证后通知作者。
+{% asset_img example.jpg This is an example image %}
+——此方法经验证有效，例子：{% asset_img 11.png 鼠标移动到图片上时出现这些文字 %}
+```
+
+**Link**
+
+在文章中插入链接，并自动给外部链接添加 target="_blank" 属性。
+
+```
+{% link text url [external] [title] %}
+```
+
+**Include Code**
+
+插入 source 文件夹内的代码文件。
+
+```
+{% include_code [title] [lang:language] path/to/file %}
+```
+
+**Youtube**
+
+在文章中插入 Youtube 视频。
+
+```
+{% youtube video_id %}
+```
+
+**Vimeo**
+
+在文章中插入 Vimeo 视频。
+
+```
+{% vimeo video_id %}
+```
+
+**引用文章**
+
+引用其他文章的链接。
+
+```
+{% post_path slug %}
+{% post_link slug [title] %}
+```
+
+**引用资源**
+
+引用文章的资源。
+
+```
+{% asset_path slug %}
+{% asset_img slug [title] %}
+{% asset_link slug [title] %}
+```
+
+**Raw**
+
+如果您想在文章中插入 Swig 标签，可以尝试使用 Raw 标签，以免发生解析异常。
+
+```
+{% raw %}
+content
+{% endraw %}
+```
+
+## 内部链接
+
+因目录级数限制，如果需要在文章中使用“多级目录”，则可转化为文章的内部链接，使用方式为：
+
+```
+[内部链接测试](#nbljce)
+
+<p id="nbljce">跳到我这了！</p>
+```
+
+这里的"nbljce"为id，其中p标签可以切换为其它html标签。
+
+**效果：**
+
+[内部链接测试](#nbljce)
+
+<p id="nbljce">跳到我这了！</p>
+
+
+
+## 审核与上传
+