Markdown语法及书写规范

Markdown语法及书写规范

引用文本:Markdown is a text formatting syntax inspired

语法指导

普通内容

这段内容展示了在内容里面一些小的格式,比如:

  • 加粗 - 例子:**加粗**
  • 倾斜 - 例子:*倾斜*
  • 删除线 - 例子:~~删除线~~
  • Code 标记 - 'Code 标记' (这里的符号是‘反引号’,即 ` )
  • 超级链接
    • 例子:[超级链接](http://github.com)
      -中括号中填写链接名字,小括号中填写链接地址
  • username@gmail.com
    • [username@gmail.com](mailto:username@gmail.com)

大标题 - Heading 3

你可以选择使用 H2 至 H6,使用 ##(N) 打头,H1 不能使用,会自动转换成 H2。

NOTE: 别忘了 # 后面需要有空格!

Heading 4

  • 例子:#### Heading 4
Heading 5
  • 例子:##### Heading 5
Heading 6
  • 例子:###### Heading 6

图片

![alt 文本](http://image-path.png)
![alt 文本](http://image-path.png "图片 Title 值")
![设置图片宽度高度](http://image-path.png =300x200)
![设置图片宽度](http://image-path.png =300x)
![设置图片高度](http://image-path.png =x200)

代码块

普通

*emphasize*    **strong**
_emphasize_    __strong__
@a = 1

有序、无序列表

无序列表

  • Go
    • Gofmt
    • Revel
    • Gin
    • Echo
  • PHP
    • Laravel
    • ThinkPHP
例子:
 - Go
  - Gofmt
  - Revel
  - Gin
  - Echo
- PHP
  - Laravel
  - ThinkPHP
前面添加一个-即可,空格形成子节点

有序列表

  1. Go
  2. Gofmt
  3. Revel
  4. Gin
  5. Echo
  6. PHP
  7. Laravel
  8. ThinkPHP
  9. Java
1. Go
  1. Gofmt
  2. Revel
  3. Gin
  4. Echo
2. PHP
  1. Laravel
  2. ThinkPHP
3. Java
"数字."添加在前面即可

表格

如果需要展示数据什么的,可以选择使用表格哦

left center right
cell 1 cell 2 cell 7
cell 3 cell 4 cell 8
cell 5 cell 6 cell 9
例子:
| left     | center   | right    |
| -------- |:--------:| --------:|
| cell 1   | cell 2   | cell 7   |
| cell 3   | cell 4   | cell 8   |
| cell 5   | cell 6   | cell 9   |

段落

留空白的换行,将会被自动转换成一个段落,会有一定的段落间距,便于阅读。

请注意后面 Markdown 源代码的换行留空情况。

Markdown书写规范

  • 文章标题从#开始向后加,每降一级加一个#。
  • 注释以及命令行命令用>。
  • 区块注释用```(注意闭合)。
  • 画重点词句用`(注意闭合)。
  • 链接如果是下载链接,需要写成:例如:liteIDE(下载链接)的形式。
  • 一段话里的备注需要用斜体展示。例如
  • 一段话里的重点用加粗表示。例如
  • 目录结构采用如下形式:
|--E:golang
  |--GOPATH
    |--bin
    |--pkg
    |--src
  |--GOROOT
    |--
    ...
    |--
  //之后都是自己写的项目
  |--project_1
    |--bin
    |--pkg
    |--src
      //每个项目里面的子项目
      |--new_1
      ...
      |--new_n
  |--project_2
    |--bin
    |--pkg
    |--src
      |--new_1
      ...
      |--new_n
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容

  • Cmd Markdown 简明语法手册 标签: Cmd-Markdown 1. 斜体和粗体 使用 * 和 ** 表...
    zjfclimin阅读 947评论 0 1
  • 这是一篇讲解如何正确使用 Markdown 的排版示例,学会这个很有必要,能让你的帖子有更加清晰的排版。 本教程来...
    leezerofly阅读 481评论 0 1
  • << 访问 Wow!UbuntuNOTE: This is Simplelified Chinese Editio...
    Xiaosonl阅读 1,335评论 0 2
  • Markdown 语法 之剑 2016.5.3 23:41:46 hljs.initHighlightingOnL...
    光剑书架上的书阅读 1,626评论 1 5
  • 参考文章:Markdown 语法说明 (简体中文版) 概述 兼容 HTML 不在 Markdown 涵盖范围之内的...
    Bwing阅读 916评论 0 3