聊城做手机网站,铜川网站seo,网站建设业务的途径的体会,有哪些网站可以做笔译本文是转载文章#xff0c;文章的来源#xff1a;csdn博客 博主#xff1a;果冻虾仁 文章#xff1a; GitHub上README写法暨GFM语法解读
博文地址#xff1a;https://blog.csdn.net/guodongxiaren/article/details/23690801 转载请保留原作者guodongxiaren的原文地址文章的来源csdn博客 博主果冻虾仁 文章 GitHub上README写法暨GFM语法解读
博文地址https://blog.csdn.net/guodongxiaren/article/details/23690801 转载请保留原作者guodongxiaren的原文地址
http://blog.csdn.net/guodongxiaren/article/details/23690801
本文在GitHub的演示地址
https://github.com/guodongxiaren/README
--------------------------------------------------------------------
自从开始玩GitHub以来就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴帮助更多的还不会编写README文件的同学们。
README文件后缀名为md。md是markdown的缩写markdown是一种编辑博客的语言。用惯了可视化的博客编辑器比如CSDN博客囧这种编程式的博客编辑方案着实让人眼前一亮。不过GitHub支持的语法在标准markdown语法的基础上做了修改称为Github Flavored Markdown简称GFM。可不是GFW呀。
————————————————————————————
我在GitHub上为本文建的一个仓库“README”供大家查看代码即具体效果README
本仓库README文件持续更新新的知识点可能不会更新到博文中。首先强烈建议一条不要用360或搜狗浏览器访问GitHub网站你会发现此时网站上很多按钮都不可用。。建议使用火狐或谷歌浏览器访问GitHub
————————————————————————————
开始编辑README
打开你的GitHub的某个项目我们可以直接在线编辑你的README文件如果你已经有了这个文件则在文件目录中直接点击它如果你还没有这个文件那么点击项目名称右边的一个按钮来添加新文件 然后你就打开了编辑页面编辑区的左上角有填写文件名的区域注意加上后缀.md 如果你本来就有这个文件要重新编辑它的话那么在点击了文件目录中的该文件后在上方有工具栏选择Edit 然后滚动屏幕到下面如果是新文件会有一个Commit new file的按钮若没有内容是不能点击的。如果是旧文件重修编辑那么这个按钮显示的是 Commit changes //顺便吐槽一句如果是360或搜狗浏览器的话这个按钮是永远都无法点击的囧。。
先随便写的东西把这个新文件提交然后再点击 Edit 重新打开它。你会发现编辑区左上角有了变化。 默认选中Code即我们的编辑模式。若点击 Preview预览就能实时显示当前的显示效果了。
好了下面正式开始编辑这个文件 关于标题
规范的README文件开头都写上一个标题这被称为大标题。 [plain] view plain copy
大标题
在文本下面加上 等于号 那么上方的文本就变成了大标题。等于号的个数无限制但一定要大于0个哦。。 比大标题低一级的是中标题也就是显示出来比大标题小点。 [plain] view plain copy
中标题 -------
在文本下面加上 下划线 - 那么上方的文本就变成了中标题同样的 下划线个数无限制。
除此之外你也会发现大中标题下面都有一条横线没错这就是 和 - 的显示结果。
如果你只输入了等于号但其上方无文字那么就只会显示一条直线。如果上方有了文字但你又只想显示一条横线而不想把上方的文字转义成大标题的话那么你就要在等于号和文字直接补一个空行。
补空行是很常用的用法当你不想上下两个不同的布局方式交错到一起的时候就要在两种布局之间补一个空行。
如果你只输入了短横线减号-其上方无文字那么要显示直线必须要写三个减号以上。不过与等于号的显示效果不同它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_同样的这两者符号也要写三个以上才能显示一条虚横线。 除此以外关于标题还有等级表示法分为六个等级显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #二级标题有两个# 以此类推。 [plain] view plain copy
#一级标题 ##二级标题 ###三级标题 ####四级标题 #####五级标题 ######六级标题
注意井号#和标题名称要并排写作一行显示效果如图 实际上前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同中标题大小和二级标题相同。
显示文本 普通文本
直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行需要使用br(或者br/)。也就是html里面的标签。事实上markdown支持一些html标签你可以试试。当然如果你完全使用html来写的话就丧失意义了毕竟markdown并非专门做前端的然而仅实现一般效果的话它会比html写起来要简洁得多得多啦。 [plain] view plain copy
这是一段普通的文本 直接回车不能换行br 要使用\br
注意第三行的br前加了反斜杠 \ 。目的就是像其他语言那样实现转义也就是 的转义。 效果如图 此外要显示一个超链接的话就直接输入这个链接的URL就好了。显示出来会自动变成可链接的形式的。
显示空格的小Tip
默认的文本行首空格都会被忽略的但是如果你想用空格来排一下版的话怎么办呢有个小技巧那就是把你的输入法由半角改成全角就OK啦。
单行文本
使用两个Tab符实现单行文本。 [plain] view plain copy
Hello,大家好我是果冻虾仁。
注意前面有两个Tab。在GitHub上单行文本显示效果如图 多行文本
多行文本和单行文本异曲同工只要在每行行首加两个Tab [plain] view plain copy
欢迎到访 很高兴见到您 祝您早上好中午好下午好晚安 部分文字的高亮
如果你想使一段话中部分文字高亮显示来起到突出强调的作用那么可以把它用 包围起来。注意这不是单引号而是Tab上方数字1左边的按键注意使用英文输入法。
Thank You . Please Call Me Coder 文字超链接
给一段文字加入超链接的格式是这样的 [ 要显示的文字 ]( 链接的地址 )。比如 [plain] view plain copy
[我的博客](http://blog.csdn.net/guodongxiaren)
显示效果
你还可以给他加上一个鼠标悬停显示的文本。 [plain] view plain copy
[我的博客](http://blog.csdn.net/guodongxiaren 悬停显示)
即在URL之后 用双引号括起来一个字符串。同样要注意这里是英文双引号。 插入符号
圆点符
这是一个圆点符这也是一个圆点符
上面这段的圆点是CSDN博客编辑器里面的符号列表。写文章在列出条目时经常用到。在GitHub的markdown语法里也支持使用圆点符。编辑的时候使用的是星号 * [plain] view plain copy
* 昵称果冻虾仁 * 别名隔壁老王 * 英文名Jelly
要注意的是星号* 后面要有一个空格。否则显示为普通星号。上文的显示效果如图 此外还有二级圆点和三级圆点。就是多加一个Tab。 [plain] view plain copy
* 编程语言 * 脚本语言 * Python
第二行一个Tab第三行两个Tab。这样用来表示层级结构就更清晰了吧看效果 如果你觉得三级的结构还不够表达清楚的话我们可以试着换一种形式请看字符包围 缩进
缩进的含义是很容易理解的。。 [plain] view plain copy
数据结构 树 二叉树 平衡二叉树 满二叉树
显示效果 当然比这个更一般的用法是这样。常常能在书籍里面看到的效果比如引用别人的文章。直接看效果。 具体这个“缩进”的用法。大家自己摸索吧。
插入图片 来源于网络的图片 网上有很多README插入图片的教程了经我自己多次测试呢发现可以使用的最简单最基本的语法是 [plain] view plain copy
即 叹号! 方括号[ ] 括号( ) 其中叹号里是图片的URL。
如果不加叹号! ,就会变成普通文本baidu了。
在方括号里可以加入一些 标识性的信息比如 [plain] view plain copy
 这个方括号里的baidu并不会对图像显示造成任何改动如果你想达到鼠标悬停显示提示信息那么可以仿照前面介绍的文本中的方法就是这样 [plain] view plain copy
在URL后面加一个双引号包围的字符串显示效果如图 GitHub仓库里的图片
有时候我们想显示一个GitHub仓库(或者说项目)里的图片而不是一张其他来源网络图片因为其他来源的URL很可能会失效。那么如何显示一个GitHub项目里的图片呢
其实与上面的格式基本一致的所不同的就是括号里的URL该怎么写。 https://github.com/ 你的用户名 / 你的项目名 / raw / 分支名 / 存放图片的文件夹 / 该文件夹下的图片
这样一目了然了吧。比如 [plain] view plain copy
我在GitHub上的用户名guodongxiaren有一个项目ImageCacheraw表示原数据的意思吧不用管它主分支master项目里有一个文件夹LogoLogo文件夹下有一张图片foryou.gif 给图片加上超链接
如果你想使图片带有超链接的功能即点击一个图片进入一个指定的网页。那么可以这样写 [plain] view plain copy
[![baidu]](http://baidu.com) [baidu]:http://www.baidu.com/img/bdlogo.gif 百度Logo
这两句和前面的写法差异较大但是也极易模仿着写出就不过多介绍了。只需注意上下文中的 baidu 是你自己起的标识的名称可以随意但是一定要保证上下两行的 标识 是一致的。
这样就能实现 点击图片进入网页的功能了。 插入代码片段
我们需要在代码的上一行和下一行用 标记。 不是三个单引号而是数字1左边Tab键上面的键。要实现语法高亮那么只要在 之后加上你的编程语言即可忽略大小写。c语言可以写成c也可以是cpp。看代码 实际显示效果 [题外话]在GitHub上用Gist写日记吧
看了这么多markdown的语法你一定不满足于仅仅写一个README文件了开始跃跃欲试想实际用markdown语法来编写博客或文章了吧。的确网上也有依托或者支持markdown语法的博客。但是呢更方便的是你可以借助GitHub本身就有的一个功能——Gist。
Gist是以文件为单位的不是以项目为单位的。而且与普通的GitHub上建的仓库不同Gist是private的哦。普通的项目默认都是public的要想弄成private貌似还要交钱的样子。既然是private那么用来写写日记是极好的。
GitHub网页的顶部有 点进去: 这就是你可以编辑的私有文件它不仅支持Text文本还支持各种编程语言呢当然也包括markdown。输入文件名 最后保存选中 Create Secret Gist 就是私有的喽。 我在GitHub上为本文建的一个项目供大家查看代码即具体效果https://github.com/guodongxiaren/README
readme添加图片
本文是转载文章文章的来源csdn博客 博主young-hz 文章 GitHub中README.md添加图片方式 博文地址https://blog.csdn.net/u012150179/article/details/24605419 首先找到repo中图片点击图片可获得路径如
https//github.com/younghz/Markdown/blob/master/Res/Aaron_Swartz.jpg
以Markdown语法如
形式添加到README文件中即可但是需要注意的是在下面的链接中需将blob改为raw。
