Markdown语法及书写规范

Markdown语法及书写规范

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

语法指导

普通内容

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

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

大标题 - 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

你可能感兴趣的:(Markdown语法及书写规范)