GitHub ReadME.md Grammar

GitHub ReadME.md Grammar

最近提交GitHub时发现有些人的ReadME.md写的非常漂亮,很好奇他们是怎么做到的,于是就搜了一下,原来ReadME.md不仅仅是随便写写的,它是由其特殊的语法的叫Markdown,刚好hexo写文章用的也是Markdown,所以这里列出一些基本的语法,以便于以后写ReadME.md时参考。

二、编辑基本语法 (注意⚠️中间需要有一个空格 )

1、字体格式强调

我们可以使用下面的方式给我们的文本添加强调的效果


*强调*  (示例:斜体) 

_强调_  (示例:斜体) 

**加重强调**  (示例:粗体) 

__加重强调__ (示例:粗体) 

***特别强调*** (示例:粗斜体) 

___特别强调___  (示例:粗斜体) 

标题等级

关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。例如:


# 一级标题 

## 二级标题 

### 三级标题 

#### 四级标题 

##### 五级标题 

###### 六级标题

2、代码


`<hello world>`

3、代码块高亮

三个反引号标签

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、引用


> 第一行引用文字 

> 第二行引用文字

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容

  • 最近对github的README.md文件颇为感兴趣。便写下这贴,帮助更多的还不会编写README文件的同学们。R...
    GB_speak阅读 1,378评论 0 7
  • << [访问 Wow!Ubuntu](http://wowubuntu.com)**NOTE:** This is...
    金木水火土V阅读 594评论 0 1
  • https://github.com/guodongxiaren/README/edit/master/READM...
    wustzhy阅读 251评论 0 0
  • 发现自己进步不大,原因可能是专注不够! 我应该还是一个很上进的人,工作之余,学习英语,参加课程学习,还有写一下简书...
    Jasonjiangsmile阅读 328评论 0 0
  • 坚持打卡第11天 练字打卡第8天,今天由于去学校参加心理咨询师培训,没有前几天那么多的时间,而且早上还起来晚了,挺...
    田慧婷阅读 289评论 0 0