Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 2.61 KB

Apache Flink China 社区文章整理指南.md

File metadata and controls

120 lines (82 loc) · 2.61 KB

用 Markdown 编辑参与社区文章整理计划

志愿者,感谢参与整理 Apache Flink China 社区文章。这是一份简要的引导指南,希望可以帮助您顺利地参与社区文章整理计划。


排版要求

  1. 请注意英文名词正确大小写拼写方式;
  2. 中英文之间添加空格

标题

题头包含:'标题'+'文章概述'+'作者'+'整理'+'校对' 若其中成员为社区志愿者,在名字后以括号备注。如下

# 文章标题 文章概述 作者:张三 整理:李四(Apache Flink China 社区志愿者) 校对:王五

提交形式

提交以 Markdown + 图片包的形式发送给【赵慧 / 茹丹】。 其中图片包中图片需与 Markdown 中图片链接命名一致,链接部分空出。如下

![图1]()

——————————————————————————————————

常用语法

标题

语法格式:** '#'+'空格'+'文本' **

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

列表

无序列表语法格式:** '-' + '空格' + '文本' **

  • 文本一
  • 文本二
  • 文本三

有序列表语法格式:** '数字' + '.' + '空格' + '文本' **

  1. 文本一
  2. 文本二
  3. 文本三

链接和图片

在 Markdown 中插入链接不需要其他按钮,你只需要使用[显示文本](链接地址)这样的格式语法即可。例如: flink-china 插入图片的语法与插入链接的语法很像,只是前面多了一个 !.语法如下: ![图片的标注](图片链接地址)

引用

语法:** '>'+'空格'+'文本' **

例如:

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。

代码

如下是代码段的语法:

```编程语言
 这是代码段
```

例如:

def bubbleSort(alist):
 for passnum in range(len(alist)-1,0,-1):
 #print alist,passnum
 for i in range(passnum):
 if alist[i]>alist[i+1]:
 temp = alist[i]
 alist[i] = alist[i+1]
 alist[i+1] = temp
 return alist

表格

Markdown Extra 表格语法:

项目 价格
iPhone $560
iPad $780
iMac $1000

可以使用冒号来定义对齐方式:

项目 价格 数量
iPhone 6000 元 5
iPad 3800 元 12
iMac 10000 元 234

结语

以上是最常见的 Markdown 的语法和格式,非常感谢您参与社区文章整理计划