catlogjs
Version:
Static site generator, translate human readable text format(such as markdown) into html, with a lot of other functions
49 lines (36 loc) • 1.73 kB
Markdown
Markdown是一种书写格式, catlog使用GitHub Flavored Markdown(GFM).
## 常用语法
### 标题
```markdown
## 二级标题
### 三级标题
#### 四级标题
```
### 段落
一个段落是由一个或多个连续的行构成,段落间靠一个或以上空行来划分。
### 列表
* 无序:`*`或`-` ,符号与正文之间需要有空格
* 有序:`1.` `2.` `3.` 符号与正文之间需要有空格
### 链接
```markdown
[百度](http://baidu.com)
```
注:`[]`与`()`之间没有空格.
### GFM拓展
1. 换行
- GFM将段落中新的一行作为换行来对待。
2. url自动显示为链接样式
- GFM将会自动链接标准的urls。
3. 添加任务列表
- 另外,通过以`[ ]`或`[x]`开始,列表可以变为任务列表。
4. 代码块
- 将你的代码块囊括在\`\`\`中间即可。不管这种方式还是传统的代码块书写方式,都需要在代码块之前留出一行空行。
5. 添加代码高亮显示
- 在代码块前面一个\`\`\`之后添加代码语言名字,for example,\`\`\`sh.
### 资源
* 如果需要了解更多标准markdown 可以去[维基百科](http://zh.wikipedia.org/wiki/Markdown)
* 如果需要了解更多GFM,可以去[GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown)
* mac上一个很好用的markdown编辑器:mou,优点在于可以即时看到网页效果,实时保存。[下载地址](http://mouapp.com/).
* windows上一个比较好用的markdown编辑器:markdownPad,优点在于可以即时看到网页效果,实时保存。[下载地址](http://markdownpad.com/ ).
### 备注
* 这篇博文就是用markdown语法写成的,你可以复制黏贴到你的编辑器里去看。