HOW TO USE README
README 使用

Readme

本文用来显示README的各种markdown语法,参考自 果冻虾仁

横线


***、—、___可以显示横线效果




标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本

普通文本

这是一段普通的文本

单行文本

hello,这个是一行单行文本

在一行开头加入1个tab或者4个空格

本文块

语法1

在连续几行的文本开头加入1个Tab或者四个空格

  hello
  world

语法2

使用一对各三个的反引号:

hello
world

该语法也可以实现代码高亮,见代码高亮

文字高亮

文字高亮功能:使行内部分文字高亮,使用一对反引号. 语法:

`linux`

效果: linux 也适合做一篇文章的tag

换行

直接回车不可以换行 可以在上一行文本后面补两个空格, 这样下一行的文本就换行了

或者就是在两行文本直接加一个空格.

也能实现换行效果,不过这个行间距有点大.

斜体、粗体、删除线

语法效果
*斜体1*斜体
*斜体2*斜体2
**粗体**粗体
__粗体2__粗体
这是一个删除线~~删除线~~删除线
***斜粗体***斜粗体
_**斜粗体2**_斜粗体2
***~~斜粗体删除线~~***斜粗体删除线
~~***斜粗体删除线***~~斜粗体删除线
斜体、粗体、删除线可混合使用

图片

基本格式:

![alt](URL title)

alt和title即对应HTML中的alt和title属性(都可省略):

  • alt表示图片显示失败时的替换文本
  • title表示鼠标悬停在图片时的显示文字(注意这里要加引号)

URL即图片的url地址,如果饮用本仓库中的图片,直接使用相对路径就可以了,如果引用其他github仓库中的图片要注意格式,即:仓库地址/raw/分支名/图片路径,即:

https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
#语法效果
1![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")baidu

链接

链接外部URL

#语法效果
1[我的博客](https://www.xmxhxx.cn "悬停提示")我的博客

链接github仓库里的URL

语法效果
[我的简介](/example/profile.md)我的简介

图片链接

给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本,而图片链接[ ]里面则是要显示的图片。

#语法效果
1[![weibo-logo]](http://weibo.com/linpiaochen)weibo-logo

锚点

每一个标题就是一个锚点,和HTML的锚点(#)类似

语法效果
[回到顶部](#readme)回到顶部

注意:标题中的英文字母都被转化为小写字母

列表

无序列表

语法

* 昵称:xxx
- 别名:bbb
* 英文名:ccc

效果

  • 昵称:xxx

  • 别名:bbb

  • 英文名:ccc

多级无序列表

语法

* 编程语言
    * 脚本语言
        * Python

效果

  • 编程语言
    • 脚本语言
      • Python

一级有序列表

语法

在数字后面加点

1. 这是1
2. 这是2

效果

  1. 这是1
  2. 这是2

多级有序列表

语法

1. 这是一级1
    1. 这是二级1
        1. 这是三级1

效果

  1. 这是一级1
    1. 这是二级1
      1. 这是三级1

复选框列表

语法

- [x] 需求分析
- [ ] 编码

效果

  • 需求分析
  • 编码

块引用

常用于引用文本

文本摘自《深入理解计算机系统》P27

 令人吃惊的是,在哪种字节顺序是合适的这个问题上,人们表现得非常情绪化。实际上术语“little endian”(小端)和“big endian”(大端)出自Jonathan Swift的《格利佛游记》一书,其中交战的两个派别无法就应该从哪一端打开一个半熟的鸡蛋达成一致。因此,争论沦为关于社会政治的争论。只要选择了一种规则并且始终如一的坚持,其实对于哪种字节排序的选择都是任意的。

“端”(endian)的起源 以下是Jonathan Swift在1726年关于大小端之争历史的描述:
“……下面我要告诉你的是,Lilliput和Blefuscu这两大强国在过去36个月里一直在苦战。战争开始是由于以下的原因:我们大家都认为,吃鸡蛋前,原始的方法是打破鸡蛋较大的一端,可是当今的皇帝的祖父小时候吃鸡蛋,一次按古法打鸡蛋时碰巧将一个手指弄破了,因此他的父亲,当时的皇帝,就下了一道敕令,命令全体臣民吃鸡蛋时打破较小的一端,违令者重罚。”

块引用有多级结构

语法

> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树

效果

数据结构

二叉树

平衡二叉树

满二叉树

代码高亮

语法

在三个反引号后面加上编程语言的名字,另起一行开始写代码,最后一行再加上三个反引号

效果

public static void main(String[]args){} //JAVA
int main(int argc, char *argv[]) //C
echo "hello GitHub" #Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp

表格

表头1表头2
表格单元表格单元
表格单元表格单元

对齐

左对齐居中右对齐
col 3 issome wordy text$1600
col 2 iscentered$12
zebra stripesare neat$1

表情

比如:blush:,可以显示:blush:。 具体每一个表情的符号码,可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com

diff语法

版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。 GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。

语法

其语法与代码高亮类似,只是在三个反引号后面写diff, 并且其内容中,可以用 +开头表示新增,-开头表示删除。 另外还有有 !#的语法。

效果

+ 人闲桂花落,
- 夜静春山空。
! 月出惊山鸟,
# 时鸣春涧中。

最后修改于 2022-05-28