现在时间是:
当前位置:首 页 >> 语言基础>> 文章列表

Github readme.md编辑技巧

作者:   发布时间:2016-04-13 16:23:44   浏览次数:1780

 

README

该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在标准的markdown语法基础上做了扩充,称之为GitHub Flavored Markdown。简称GFM,GFM在GitHub上有广泛应用,除了README文件外,issues和wiki均支持markdown语法。


            Author:yeayee

          Web:yeayee.com

 

目录

***、---、___显示虚横线




一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

显示文本

普通文本

这是一段普通的文本

关于换行

直接回车不能换行,
可以使用<br>。 但是使用html标签就丧失了markdown的意义。
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。

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

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

单行文本

Hello,大家好,我是果冻虾仁。 

文本块

欢迎到访 很高兴见到您 祝您,早上好,中午好,下午好,晚安 

部分文字高亮

Thank You . Please Call Me Coder

高亮功能更适合做一篇文章的tag

例如:
java 网络编程 Socket 全双工

删除线

这是一个 删除线

斜体

斜体1

斜体2

粗体

粗体1

粗体2

组合使用粗体、斜体和删除线

斜粗体1

斜粗体2

斜粗体删除线1

斜粗体删除线2

链接

链接外部URL

我的博客 语法如下:

[我的博客](http://yeayee.com "悬停显示") 

链接的另一种写法

我的博客

语法如下:

[我的博客][id] [id]:http://yeayee.com "悬停显示" 

中括号[ ]里的id,可以是数字,字母等的组合。这两行可以不连着写,一般把第二行的链接统一放在文章末尾,id上下对应就行了。这样正文看起来会比较干净。

链接本仓库里的URL

Book 语法如下:

[Book](./Book) 

如果文件要引用的文件不存在,则待点击的文本为红色。引用的文件存在存在则文本为蓝色。

锚点

我们可以使用HTML的锚点标签(#)来设置锚点:回到目录
但其实呢,每一个标题都是一个锚点,不需要用标签来指定,比如我们 回到顶部 不过不幸的是,由于对中文支持的不好,所以中文标题貌似是不能视作标签的。

显示图片

来源于网络的图片

baidu 

GitHub仓库中的图片

给图片加上超链接

第一种

head

第二种

内容任意

列表

圆点列表

  • 昵称:果冻虾仁
  • 别名:隔壁老王
  • 英文名:Jelly

更多圆点

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

数字列表

一般效果

就是在数字后面加一个点,再加一个空格。不过看起来起来可能不够明显。
面向对象的三个基本特征:

  1. 封装
  2. 继承
  3. 多态

数字列表自动排序

也可以在第一行指定1.,而接下来的几行用星号*(或者继续用数字1. )就可以了,它会自动显示成2、3、4……。
面向对象的七大原则:

  1. 开闭原则
  2. 里氏转换原则
  3. 依赖倒转原则
  4. 接口隔离原则
  5. 组合/聚合复用原则
  6. “迪米特”法则
  7. 单一直则原则

多级数字列表

和圆点的列表一样,数字列表也有多级结构:

  1. 这是一级的数字列表,数字1还是1
    1. 这是二级的数字列表,阿拉伯数字在显示的时候变成了罗马数字
      1. 这是三级的数字列表,数字在显示的时候变成了英文字母
        1. 四级的数字列表显示效果,就不再变化了,依旧是英文字母

复选框列表

  •  C
  •  C++
  •  Java
  •  Qt
  •  Android
  •  C#
  •  .NET

您可以使用这个功能来标注某个项目各项任务的完成情况。

块引用

常用于引用文本

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

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

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

块引用有多级结构

数据结构

二叉树

平衡二叉树

满二叉树

代码高亮

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
Content Cell Content Cell
Content Cell Content Cell
表头1 表头2
Content Cell Content Cell
Content Cell Content Cell
名字 描述
Help Display the help window.
Close Closes a window

表格中也可以使用普通文本的删除线,斜体等效果

名字 描述
Help Display the help window.
Close Closes a window

表格可以指定对齐方式

左对齐 居中 右对齐
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1

表格中嵌入图片

图片 描述
baidu baidu

添加表情

Github的Markdown语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。

比如:blush:,可以显示:blush:

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

但是这个网页每次都打开奇慢。。所以我整理到了本repo中,大家可以直接在此查看emoji







上一篇:没有了    下一篇:没有了

Copyright ©2018    易一网络科技|www.yeayee.com All Right Reserved.

技术支持:自助建站 | 领地网站建设 |短信接口 版权所有 © 2005-2018 lingw.net.粤ICP备16125321号 -5