如何在Github上用Markdown写好ReadMe

MarkDown的基本语法(可以直接复制下述内容到github的readme.md显示结果)

一、标题写法:
第一种方法:
1、在文本下面加上 等于号 = ,那么上方的文本就变成了大标题。等于号的个数无限制,但一定要大于0个哦。。
2、在文本下面加上 下划线 - ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。
3、要想输入=号,上面有文本而不让其转化为大标题,则需要在两者之间加一个空行。
另一种方法:(推荐这种方法;注意⚠️中间需要有一个空格)
关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。
例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
二、编辑基本语法
1、字体格式强调
我们可以使用下面的方式给我们的文本添加强调的效果
*强调* (示例:斜体)
_强调_ (示例:斜体)
**加重强调** (示例:粗体)
__加重强调__ (示例:粗体)
***特别强调*** (示例:粗斜体)
___特别强调___ (示例:粗斜体)
2、代码
`<hello world>`
3、代码块高亮
```
@Override
protected void onDestroy() {
EventBus.getDefault().unregister(this);
super.onDestroy();
}
```
4、表格 (建议在表格前空一行,否则可能影响表格无法显示)

表头 | 表头 | 表头
---- | ----- | ------
单元格内容 | 单元格内容 | 单元格内容
单元格内容 | 单元格内容 | 单元格内容

5、其他引用
图片
![图片名称](https://www.baidu.com/img/bd_logo1.png)
链接
[链接名称](https://www.baidu.com/)
6、列表
1. 项目1
2. 项目2
3. 项目3
* 项目1 (一个*号会显示为一个黑点,注意⚠️有空格,否则直接显示为*项目1)
* 项目2

7、换行(建议直接在前一行后面补两个空格)
直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。

8、引用
> 第一行引用文字
> 第二行引用文字

页内跳转

Markdown会自动给每一个h1~h6标题生成一个锚,其id就是标题内容。目录树中的每一项都是一个跳转链接,点击后就会跳转到其对应的锚点(即标题所在位置)。你可以点击本文档开始处的目录树尝试一下。

如果需要在目录树之外还要增加跳转到某个标题的链接,则有两种办法可以做到:
1. 使用Markdown的语法来增加跳转链接:“[名称](#id)”。
2. 使用HTML语法来增加跳转链接:“<a href=”#id”>名称

其中的“名称”可以随便填写,“id”需要填写跳转到的标题的内容。Markdown中Id必须是小写,且不允许空格,空格用横线'-'代替

 

 在markdown中如何加入上标、下标?

其实了解原理后很简单。Markdown一个套兼容HTML的语法,所以使用HTML中下标下标的语法即可。
Markdown Language is a superset of HTML, so you can use html tag sub,sup to achieve this.
写法
H<sub>2</sub>O  CO<sub>2</sub>
爆米<sup>TM</sup>

效果

$$H_2O\ CO_2$$

$$爆米^{TM}$$

 

参考博客

1. https://blog.csdn.net/tearsky253/article/details/78968221

2. https://blog.csdn.net/qq_31796651/article/details/80803599

3. https://www.jianshu.com/p/13b3366f0260

posted @ 2019-04-25 16:42  拎壶冲AR  阅读(1109)  评论(0编辑  收藏  举报