Gitlab中wiki使用及Markdown的用法

问题背景

1、关于Gitlab上的issue 

每一条工单被解决完，都会打上“documentation”标签

2、wiki的使用 

带”documentation“标签的工单需要编写wiki。

3、Markdown的用法

wiki主要的文本编辑语法是Markdown。 “documentation“归档是对工单解决方法、步骤的说明。 wiki 可以编写项目的相关说明文档，用户手册等。 Markdown它允许人们使用易读易写的纯文本格式编写文档。

Gitlab中wiki的使用

议题

示例： gitlab选择项目->cpaas/cpaas->议题->Closed

议题 开启项目配额后，该项目内无法部署任何服务 带有documentation标签

议题工单下方添加评论

链接

链接 格式：[link](地址) 例如：[wiki链接](../wikis/issues12/suggest) gitlab cpaas项目成员在http://gitlab.cpaas.com/cpaas/cpaas/目录下 ../ 表示父级目录

链接 写的是相对路径 ./ 表示当前目录 ../ 表示父级目录 / 表示根目录

wiki主要的文本编辑语法是Markdown。

先在wiki中创建页面，选择Markdown格式编辑内容

页面内容编辑完成，保存更新。点击之前的wiki链接，跳转到wiki页面

无序列表需要利用星号、加号、减号做列表标记，符号后加一空格。 ` backtick重音符 红色突出显示内容 链接格式：[link](地址) 例如：[kubernetes #53533](https://github.com/kubernetes/kubernetes/issues/53533)

* k8s上有两个概念和资源配额相关分别是`LimitRange`和`ResourceQuota`，

* cpu是压缩资源，内存属于不可压缩资源，超过limit的行为不一样：  

 * cpu超过限制：    

  * 会被节流，得到cpu占用时间变少  

 * 内存超过限制：    

  * 传统系统上，会发生Swapping（写物理盘），读写swap分区性能会降低10倍左右，k8s由于[kubernetes #53533](https://github.com/kubernetes/kubernetes/issues/53533)的复杂性，目前不考虑支持swap    

  * k8s上一旦超过内存限制，将引发被OOM

效果：

Markdown的用法

注释符

#注释符

1.标题

# 一级标题

## 二级标题

###### 六级标题

注：#后有一空格 

列表

无序列表需要利用星号、加号、减号做列表标记，符号后加一空格。 有序列表只需使用数字接着一个英文句号，符号后加一空格。

2.列表（有序和无序）

2.1 无序列表

例如：

* 第一

* 第二

+ 第三

+ 第四

- 第五

- 第六

2.2 有序列表

例如：

1. 有

2. 序

3. 的  

  * 列  

  * 表    

    * 分  

    * 级

图片

3.图片 格式: 

强调

4.强调    使用*，_设置强调的文字。    This is a beautiful girl and she is learning the *Markdown*.May be she will know the _difference_ between _Markdown_ and *HTML*.When she know how to use it, she will love it.

*此文将为斜体*

_这也将是斜体_

**此文将为粗体**

__这也将是粗体__

*你 **可以** 混合使用*

链接

5.链接 [GitHub](http://github.com)

块引用

6.块引用

块引用使用>符号，在每行的最前面加上> ，

例如：

> This is a beautiful girl and she is learning the Markdown.

>

> May be she will know the difference between Markdown and HTML.

>

> When she know how to use it, she will love it.

Markdown允许您使用反斜杠转义来生成文本字符，否则这些字符在Markdown的格式语法中会有特殊意义。 underscore下划线 curly braces花括号 square brackets方括号 parentheses圆括号 hash mark散列符 minus sign (hyphen)减号（连字符）

反斜杠

7.反斜杠转义 \*literal asterisks\

Markdown为下面这些字符提供反斜杠转义 \ backslash    ` backtick * asterisk        _ underscore {} curly braces    [] square brackets () parentheses    # hash mark + plus sign    - minus sign (hyphen)     . dot        ! exclamation mark

提及

@wu123

1. USERNAME @MENTIONS

键入一个@符号，后跟一个用户名，将通知此人前来查看评论。 这叫做mentiones“提及”，因为你提到的是个人。你也可以提到组织内的团队。

代码块

Github Flavored Markdown(GFM)

Markdown将带有四个前导空格的文本转换为一个代码块；使用GFM（Github Flavored Markdown），您可以用```来包装代码，从而不用前导空格也能创建代码块。 添加可选的语言标识符go，高亮显示代码。

2. 高亮一段代码

```go

package main

import (              

 “fmt”              

 “os”

)

func main() {              

 fmt.Println(“hello world!”)

} ```

issue引用

任何涉及Issue或Pull的数字都将自动转换为链接。

#1

待办

制作一份待办事宜 To-do 列表

-[X]这是一个完成的项

-[]这是一个未完成的项

-[X]@mention，#refs，[链接]()，**格式化**，支持已被删除的<del>标签<del>

-[X]需要列出语法（支持任何无序或有序列表）

### 1. 制作一份待办事宜 [To-Do列表](http://gitlab.ebcpaas.com/dashboard/todos)

- [x] this is a complete item

- [ ] this is an incomplete item

- [x] @mentions, #refs, [links](),**formatting**, and <del>tags</del> supported

- [x] list syntax required (any unordered or ordered list supported)

表格

创建表格，组合词语列表，对于第一行用连字符分隔，然后用管道符'|'把每一列分开

绘制表格

第一标题 | 第二标题

------------ | -------------

单元格内容1 | 单元格内容2 内容栏1 | 内容栏2

表情

GitHub 支持的表情 :+1:  :sparkles:  :camel:  :tada: :rocket:  :metal:  :octocat:

Gitlab下能显示的表情 Github的吉祥物章鱼猫octocat在Gitlab上无法显示

要查看每个支持图像的列表，请查看www.emoji-cheat-sheet.com网站

点赞 星光 闪耀  金属礼