重写“Markdown快速开始”文档,提高文章表达效果

This commit is contained in:
TevinLi 2016-08-20 23:15:25 +08:00
parent 9db83987a2
commit 1f6fa683ff
4 changed files with 43 additions and 40 deletions

View File

@ -2,7 +2,7 @@
amWiki是一款基于atom编辑器markdown语法的轻量级wiki文库系统。
使用amWiki创建文库仅需要您使用atom编辑markdown文档和支持http静态访问网页空间
[amWiki项目托管](https://github.com/TevinLi/amWiki "amWiki项目托管地址")
传送门:[amWiki项目托管地址](https://github.com/TevinLi/amWiki "amWiki项目托管地址")
### amWiki优势
- 文档系统采用markdown语法

View File

@ -190,7 +190,7 @@
}
});
//设置网页title
$('title').text(this.$e.view.find('h1').text());
$('title').text(this.$e.view.find('h1').eq(0).text());
//设置描点
this.setTitlesAnchor();
};

View File

@ -1,4 +1,4 @@
# markdown 语法高亮
# Markdown 语法高亮
amWiki使用 [highlight.js](https://highlightjs.org/) 进行预语法高亮渲染,它能对多达一百多种语言、样式提供语法高亮解析
使用两组每组三个反引号分单独两行将代码包围起来,并在第一组反引号后写上语言类型即可使用语法高亮,例如:

View File

@ -7,7 +7,7 @@ Markdown的语法简洁明了、学习容易得到了许多著名网络平台
## 语法快速入门
### <font color=#C71585>标题</font>
### <font color=#C71585>标题</font>
在行首插入1到6个#对应1到6阶标题
# 这是 H1
## 这是 H2
@ -15,6 +15,7 @@ Markdown的语法简洁明了、学习容易得到了许多著名网络平台
#### 这是 H4
##### 这是 H5
###### 这是 H6
渲染效果:
# 这是 H1
## 这是 H2
### 这是 H3
@ -22,7 +23,7 @@ Markdown的语法简洁明了、学习容易得到了许多著名网络平台
##### 这是 H5
###### 这是 H6
### <font color=#C71585>修辞和强调</font>
### <font color=#C71585>修辞和强调</font>
使用星号和底线来标记需要强调的区段
**加粗**
@ -30,19 +31,21 @@ Markdown的语法简洁明了、学习容易得到了许多著名网络平台
*斜体*
_斜体_
渲染效果:
**加粗**
__加粗__
*斜体*
_斜体_
### <font color=#C71585>删除线</font>
### <font color=#C71585>删除线</font>
~~要删掉的内容~~
渲染效果:
~~要删掉的内容~~
### <font color=#C71585>列表</font>
无序列表使用星号、加号和减号来做为列表的项目标记
### <font color=#C71585>列表</font>
**无序列表** 使用星号、加号和减号来做为列表的项目标记
* Candy.
* Gum.
+ Booze.
@ -52,6 +55,8 @@ _斜体_
- Booze.
+ 嵌套
* 嵌套
渲染效果:
* Candy.
* Gum.
+ Booze.
@ -62,101 +67,99 @@ _斜体_
+ 嵌套
* 嵌套
有序列表则是使用一般的数字接着一个英文句点作为项目标记
**有序列表** 则是使用一般的数字接着一个英文句点作为项目标记
1. Red
50. Green
1000. Blue
渲染效果:
1. Red
50. Green
1000. Blue
### <font color=#C71585>链接</font>
### <font color=#C71585>链接</font>
在方括号后面用圆括号接上链接
这是一个[链接显示文本](http://www.baidu.com "链接title文本")
渲染效果:
这是一个[链接显示文本](http://www.baidu.com "链接title文本")
### <font color=#C71585>图片</font>
### <font color=#C71585>图片</font>
图片的语法和链接很像
![alt文本](amWiki/images/logo.png "Title")
渲染效果:
![alt文本](amWiki/images/logo.png "Title")
### <font color=#C71585>代码</font>
### <font color=#C71585>代码</font>
使用反引号 \` 来标记代码区段
我是`code``<div>division</div>`
渲染效果:
我是`code``<div>division</div>`
### <font color=#C71585>【代码段】</font>
如果要建立一个已经格式化好的代码区块,只要每行都缩进 4 个空格或是一个 tab 就可以了
var name = 'Candy'
渲染效果:
var name = 'Candy'
### <font color=#C71585>表格</font>
### <font color=#C71585>表格</font>
使用竖线分割内容,且同时使用“---”与“:”指定对齐方式
| Header01 | Header02 | Header03
| -------- | :------: | ---:
| 默认 | 居中 | 右
渲染效果:
| Header01 | Header02 | Header03
| -------- | :------: | ---:
| 默认 | 居中 | 右
### <font color=#C71585>引用</font>
### <font color=#C71585>引用</font>
只需要在文本前加入 > 这种尖括号(大于号)即可
>这里是一段引用
渲染效果:
>这里是一段引用
### <font color=#C71585>分割线</font>
### <font color=#C71585>分割线</font>
只需要三个 \- 号
---
渲染效果:
---
### <font color=#C71585>换行</font>
### <font color=#C71585>换行</font>
只需要两个以上的空格然后回车
我是首行
我换行了
渲染效果:
我是首行
我换行了
### <font color=#C71585>html</font>
### <font color=#C71585>html</font>
可以直接在文档里书写 HTML不需要额外标注这是 HTML
<div>division</div>
渲染效果:
<div>division</div>
---
## 更多
## 研究更多 markdown 语法详细细节
### 研究markdown语法详细细节
> - [创始人 John Gruber 的 Markdown 语法说明](http://daringfireball.net/projects/markdown/syntax)
> - [Markdown 中文版语法说明](http://wowubuntu.com/markdown/)
### Markdown编辑器众多
#### 在线网页编辑器
[MaHua](http://mahua.jser.me/)、 [简书](http://www.jianshu.com/)、[马克飞象](https://maxiang.io/)、[Dillinger](http://dillinger.io/)、[StackEdit](https://stackedit.io/)
#### 全平台编辑器
[Atom](https://atom.io/)、[SublimeText](http://www.sublimetext.com/)、[CmdMarkdown](https://www.zybuluo.com/mdeditor)、[小书匠编辑器](http://soft.xiaoshujiang.com/)
#### Windows平台编辑器
[MarkdownPad](http://www.markdownpad.com/)
#### OSX平台编辑器
[Mou](http://25.io/mou/)、[MacDown](http://macdown.uranusjr.com/)、[Byword](https://bywordapp.com/)
#### Linux平台编辑器
ReText、[UberWriter](http://uberwriter.wolfvollprecht.de/)
- [创始人 John Gruber 的 Markdown 语法说明](http://daringfireball.net/projects/markdown/syntax)
- [Markdown 中文版语法说明](http://wowubuntu.com/markdown/)