国内最全IT社区平台 联系我们 | 收藏本站
华晨云阿里云优惠2
您当前位置:首页 > php开源 > 综合技术 > GitHub上README.md教程

GitHub上README.md教程

来源:程序员人生   发布时间:2016-08-11 08:35:50 阅读次数:1781次

查看代码即具体效果:https://github.com/guodongxiaren/test 

————————————————————————————

开始编辑README

打开你的GitHub的某个项目,我们可以直接在线编辑你的README文件,如果你已有了这个文件,则在文件目录中直接点击它,如果你还没有这个文件那末点击项目名称右侧的1个按钮,来添加新文件:

然后你就打开了编辑页面,编辑区的左上角有填写文件名的区域,注意加上后缀.md

如果你本来就有这个文件要重新编辑它的话,那末在点击了文件目录中的该文件后,在上方有工具栏,选择Edit

然后转动屏幕到下面,如果是新文件会有1个Commit new file的按钮,若没有内容是不能点击的。如果是旧文件重修编辑,那末这个按钮显示的是 Commit changes


//顺便吐槽1句如果是360或搜狗阅读器的话,这个按钮是永久都没法点击的,囧。。

先随意写的东西把这个新文件提交,然后再点击 Edit 重新打开它。你会发现编辑区左上角有了变化。

默许选中Code,即我们的编辑模式。若点击 Preview(预览)就可以实时显示当前的显示效果了。

好了,下面正式开始编辑这个文件


关于标题

规范的README文件开头都写上1个标题,这被称为大标题

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. 大标题  
  2. ====  
在文本下面加上 等于号 = ,那末上方的文本就变成了大标题。等于号的个数无穷制,但1定要大于0个哦。。

比大标题低1级的是中标题,也就是显示出来比大标题小点。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. 中标题  
  2. -------  

在文本下面加上 下划线 - ,那末上方的文本就变成了中标题,一样的 下划线个数无穷制。

除此以外,你也会发现大,中标题下面都有1条横线,没错这就是 = 和 - 的显示结果。

如果你只输入了等于号=,但其上方无文字,那末就只会显示1条直线。如果上方有了文字,但你又只想显示1条横线,而不想把上方的文字转义成大标题的话,那末你就要在等于号=和文字直接补1个空行。

补空行:是很经常使用的用法,当你不想上下两个不同的布局方式交错到1起的时候,就要在两种布局之间补1个空行。

如果你只输入了短横线(减号)-,其上方无文字,那末要显示直线,必须要写3个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,一样的这二者符号也要写3个以上才能显示1条虚横线。

除此之外,关于标题还有等级表示法,分为6个等级,显示的文本大小顺次减小。不同等级之间是以井号  #  的个数来标识的。1级标题有1个 #,2级标题有两个# ,以此类推。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. #1级标题  
  2. ##2级标题  
  3. ###3级标题  
  4. ####4级标题  
  5. #####5级标题  
  6. ######6级标题  
注意井号#和标题名称要并排写作1行,显示效果如图:

实际上,前文所述的大标题和中标题是分别和1级标题和2级标题对应的。即大标题大小和1级标题相同,中标题大小和2级标题相同。

显示文本


普通文本

直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用
(或
)。也就是html里面的标签
事实上,markdown支持1些html标签,你可以试试。固然如果你完全使用html来写的话,就丧失意义了,毕竟markdown并不是专门做前真个,但是仅实现1般效果的话,它会比html写起来要简洁很多很多啦。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. 这是1段普通的文本,  
  2. 直接回车不能换行,
      
  3. 要使用\
      
注意第3行的
前加了反斜杠 \ 。目的就是像其他语言那样实现转义,也就是 < 的转义。

效果如图:

另外,要显示1个超链接的话,就直接输入这个链接的URL就行了。显示出来会自动变成可链接的情势的。

显示空格的小Tip

默许的文本行首空格都会被疏忽的,但是如果你想用空格来排1下版的话怎样办呢,有个小技能,那就是把你的输入法由半角改玉成角就OK啦。

单行文本

使用两个Tab符实现单行文本。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. Hello,大家好,我是果冻虾仁。  
注意前面有两个Tab。在GitHub上单行文本显示效果如图:

多行文本

多行文本和单行文本异曲同工,只要在每行行首加两个Tab

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. 欢迎到访  
  2. 很高兴见到您  
  3. 祝您,早上好,中午好,下午好,晚安  

部份文字的高亮

如果你想使1段话中部份文字高亮显示,来起到突出强调的作用,那末可以把它用 `  ` 包围起来。注意这不是单引号,而是Tab上方,数字1左侧的按键(注意使用英文输入法)。

Thank `You` . Please `Call` Me `Coder`

文字超链接

给1段文字加入超链接的格式是这样的 要显示的文字 ]( 链接的地址 )。比如:

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. [我的博客](http://blog.csdn.net/guodongxiaren)  
显示效果:

你还可以给他加上1个鼠标悬停显示的文本。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. [我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")  
即在URL以后 用双引号括起来1个字符串。一样要注意这里是英文双引号。


插入符号

圆点符

  • 这是1个圆点符
  • 这也是1个圆点符

上面这段的圆点是CSDN博客编辑器里面的符号列表。写文章在列出条目时常常用到。在GitHub的markdown语法里也支持使用圆点符。编辑的时候使用的是星号 *

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. * 昵称:果冻虾仁  
  2. * 别名:隔壁老王  
  3. * 英文名:Jelly  
要注意的是星号* 后面要有1个空格。否则显示为普通星号。上文的显示效果如图:

另外还有2级圆点和3级圆点。就是多加1个Tab。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. * 编程语言  
  2.     * 脚本语言  
  3.         * Python  
第2行1个Tab,第3行两个Tab。这样用来表示层级结构就更清晰了吧,看效果:

如果你觉得3级的结构还不够表达清楚的话,我们可以试着换1种情势,请看字符包围


缩进

缩进的含义是很容易理解的。。

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
  1. >数据结构  
  2. >>树  
  3. >>>2叉树  
  4. >>>>平衡2叉树  
  5. >>>>>满2叉树  
显示效果:

固然比这个更1般的用法是这样。常常能在书籍里面看到的效果,比如援用他人的文章。直接看效果。



具体这个“缩进”的用法。大家自己摸索吧。

插入图片


来源于网络的图片


网上有很多README插入图片的教程了,经我自己屡次测试呢,发现可使用的最简单,最基本的语法是:

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
生活不易,码农辛苦
如果您觉得本网站对您的学习有所帮助,可以手机扫描二维码进行捐赠
程序员人生
------分隔线----------------------------
分享到:
------分隔线----------------------------
关闭
程序员人生