今天研究下在GitHub中如何漂亮的书写readme部分
markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。
1、因为是纯文本,所以只要支持markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。
2、操作简单。比如:WYSIWYG编辑时标记个标题,先选中内容,再点击导航栏的标题按钮,选择几级标题。要三个步骤。而markdown只需要在标题内容前加#即可
目录:
Markdown书写规则
GitHub readme部分带格式的效果
GitHub readme部分的原始文稿
Markdown书写规则:
标题部分
加粗,加大,爽啊;
方法:给标题前面添加一个星号,也可以加多个星号,代表不同级别标题
例如
# Semantic Soft Segmentation, ACM SIGGRAPH 2018
加黑部分
方法:左右两边添加两个星号。
比如:**stand-alone**,
代码部分
黄色部分就是代码部分,可以左右拖动
方法:切换英语键盘,点击数字1左边的那个键,按三下,把代码放进反引号就好看了
比如
```
pip3 install -r requirements.txt
```
超链接
绿色部分,比如project page是超链接,给project page添加英语方括号,后面用英语圆括号包围网址
比如
[project page](http://people.inf.ethz.ch/aksoyy/sss/)
GitHub readme部分带格式的效果
https://github.com/BTUJACK/SIGGRAPH18SSS
Semantic Soft Segmentation, ACM SIGGRAPH 2018
This repository includes the semantic feature (128-D) generation approach presented in
Yagiz Aksoy, Tae-Hyun Oh, Sylvain Paris, Marc Pollefeys and Wojciech Matusik, "Semantic Soft Segmenta