iOS 【利用Markdown编辑GitHub仓库的README文件】
最近对它的README.md文件颇为感兴趣。便写下这贴,帮助更多的还不会编写README文件的同学们。
README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮。不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。可不是GFW呀。
开始编辑README
打开你的GitHub的某个项目,我们可以直接在线编辑你的README文件,如果你已经有了这个文件,则在文件目录中直接点击它,如果你还没有这个文件那么点击项目名称右边的一个按钮,来添加新文件:
然后你就打开了编辑页面,编辑区的左上角有填写文件名的区域,注意加上后缀.md
如果你本来就有这个文件要重新编辑它的话,那么在点击了文件目录中的该文件后,在上方有工具栏,选择Edit
然后滚动屏幕到下面,如果是新文件会有一个Commit new file的按钮,若没有内容是不能点击的。如果是旧文件重修编辑,那么这个按钮显示的是 Commit changes
//顺便吐槽一句如果是360或搜狗浏览器的话,这个按钮是永远都无法点击的,囧。。
先随便写的东西把这个新文件提交,然后再点击 Edit 重新打开它。你会发现编辑区左上角有了变化。
默认选中Code,即我们的编辑模式。若点击 Preview(预览)就能实时显示当前的显示效果了。
好了,下面正式开始编辑这个文件
关于标题
- 大标题
- ====
在文本下面加上 等于号 = ,那么上方的文本就变成了大标题。等于号的个数无限制,但一定要大于0个哦。。
比大标题低一级的是中标题,也就是显示出来比大标题小点。
- 中标题
- -------
在文本下面加上 下划线 - ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。
除此之外,你也会发现大,中标题下面都有一条横线,没错这就是 = 和 - 的显示结果。
如果你只输入了等于号=,但其上方无文字,那么就只会显示一条直线。如果上方有了文字,但你又只想显示一条横线,而不想把上方的文字转义成大标题的话,那么你就要在等于号=和文字直接补一个空行。
补空行:是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。
如果你只输入了短横线(减号)-,其上方无文字,那么要显示直线,必须要写三个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,同样的这两者符号也要写三个以上才能显示一条虚横线。
除此以外,关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。
- #一级标题
- ##二级标题
- ###三级标题
- ####四级标题
- #####五级标题
- ######六级标题
注意井号#和标题名称要并排写作一行,显示效果如图:
实际上,前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同,中标题大小和二级标题相同。
显示文本
普通文本
直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用<br>(或者<br/>)。也就是html里面的标签。事实上,markdown支持一些html标签,你可以试试。当然如果你完全使用html来写的话,就丧失意义了,毕竟markdown并非专门做前端的,然而仅实现一般效果的话,它会比html写起来要简洁得多得多啦。
- 这是一段普通的文本,
- 直接回车不能换行,<br>
- 要使用\<br>
注意第三行的<br>前加了反斜杠 \ 。目的就是像其他语言那样实现转义,也就是 < 的转义。
效果如图:
此外,要显示一个超链接的话,就直接输入这个链接的URL就好了。显示出来会自动变成可链接的形式的。
显示空格的小Tip
单行文本
- Hello,大家好,我是果冻虾仁。
注意前面有两个Tab。在GitHub上单行文本显示效果如图:
多行文本
- 欢迎到访
- 很高兴见到您
- 祝您,早上好,中午好,下午好,晚安
部分文字的高亮
如果你想使一段话中部分文字高亮显示,来起到突出强调的作用,那么可以把它用 ` ` 包围起来。注意这不是单引号,而是Tab上方,数字1左边的按键(注意使用英文输入法)。
Thank `You` . Please `Call` Me `Coder`
文字超链接
给一段文字加入超链接的格式是这样的 [ 要显示的文字 ]( 链接的地址 )。比如:
- [我的博客](http://blog.csdn.net/felicity294250051)
显示效果:
你还可以给他加上一个鼠标悬停显示的文本。
- [我的博客](http://blog.csdn.net/felicity294250051 "悬停显示")
即在URL之后 用双引号括起来一个字符串。同样要注意这里是英文双引号。
插入符号
圆点符
上面这段的圆点是CSDN博客编辑器里面的符号列表。写文章在列出条目时经常用到。在GitHub的markdown语法里也支持使用圆点符。编辑的时候使用的是星号 *
- * 昵称:果冻虾仁
- * 别名:隔壁老王
- * 英文名:Jelly
要注意的是星号* 后面要有一个空格。否则显示为普通星号。上文的显示效果如图:
此外还有二级圆点和三级圆点。就是多加一个Tab。
- * 编程语言
- * 脚本语言
- * Python
第二行一个Tab,第三行两个Tab。这样用来表示层级结构就更清晰了吧,看效果:
如果你觉得三级的结构还不够表达清楚的话,我们可以试着换一种形式,请看字符包围
缩进
- >数据结构
- >>树
- >>>二叉树
- >>>>平衡二叉树
- >>>>>满二叉树
显示效果:
当然比这个更一般的用法是这样。常常能在书籍里面看到的效果,比如引用别人的文章。直接看效果。
具体这个“缩进”的用法。大家自己摸索吧。
插入图片
来源于网络的图片
网上有很多README插入图片的教程了,经我自己多次测试呢,发现可以使用的最简单,最基本的语法是:
- ![](http://www.baidu.com/img/bdlogo.gif)
即 叹号! + 方括号[ ] + 括号( ) 其中叹号里是图片的URL。
如果不加叹号! ,就会变成普通文本baidu了。
在方括号里可以加入一些 标识性的信息,比如
- ![baidu](http://www.baidu.com/img/bdlogo.gif)
这个方括号里的baidu并不会对图像显示造成任何改动,如果你想达到鼠标悬停显示提示信息,那么可以仿照前面介绍的文本中的方法,就是这样:
- ![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")
在URL后面,加一个双引号包围的字符串,显示效果如图:
GitHub仓库里的图片
有时候我们想显示一个GitHub仓库(或者说项目)里的图片而不是一张其他来源网络图片,因为其他来源的URL很可能会失效。那么如何显示一个GitHub项目里的图片呢?
其实与上面的格式基本一致的,所不同的就是括号里的URL该怎么写。
https://github.com/ 你的用户名 / 你的项目名 / raw / 分支名 / 存放图片的文件夹 / 该文件夹下的图片
- ![](https://github.com/CoderZYWang/WebViewJSBridgeDemoForSwift/blob/master/wzy.jpg?raw=true)
我在GitHub上的用户名guodongxiaren;有一个项目ImageCache;raw表示原数据的意思吧,不用管它;主分支master;项目里有一个文件夹Logo;Logo文件夹下有一张图片foryou.gif
给图片加上超链接
如果你想使图片带有超链接的功能,即点击一个图片进入一个指定的网页。那么可以这样写:
- [![baidu]](http://baidu.com)
- [baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"
这两句和前面的写法差异较大,但是也极易模仿着写出,就不过多介绍了。只需注意上下文中的 baidu 是你自己起的标识的名称,可以随意,但是一定要保证上下两行的 标识 是一致的。
这样就能实现 点击图片进入网页的功能了。
插入代码片段
实际显示效果
[题外话]在GitHub上用Gist写日记吧
点进去:
这就是你可以编辑的私有文件,它不仅支持Text文本,还支持各种编程语言呢!当然也包括markdown。输入文件名:
最后保存,选中 Create Secret Gist 就是私有的喽。
iOS 【利用Markdown编辑GitHub仓库的README文件】相关推荐
- 怎么用pycharm更新python_利用PyCharm操作Github(仓库新建、更新,代码回滚)
Github是目前世界上最流行的代码存储和分享平台,而PyCharm是Python圈中最流行的IDE,它很好地支持了Git操作.本文将会介绍如何利用PyCharm来连接Github,同时演示Githu ...
- anaconda下利用git维护github仓库
anaconda下利用git维护github仓库 说实话,windows下利用github客户端维护github仓库是非常方便的,唯一不方便的是github客户端的下载安装,每次换电脑或重装系统都要装 ...
- 彻底删除GitHub仓库的某个文件或文件夹及其历史记录
如何彻底删除GitHub仓库中某个文件(文件夹)及其历史记录 最近写blog的代码,误操作把带有自己邮箱的SMTP的后台接口文件一起push到远程仓库了. 由于如果此误操作,直接删除此文件的话,依然能 ...
- android远程调用github仓库的aar文件
前期github仓库代码的clone和上传请参考 https://blog.csdn.net/chehec2010/article/details/89950964 https://blog.csdn ...
- 【看这一篇就够了】如何删除gitHub仓库中的文件
方法一通过命令操作,可以同时删除本地仓库与远程仓库的文件: 方法二简单易行,但只能删除远程仓库的文件. 方法一:通过命令 这需要我们本地用命令来进行删除: 1.git clone 我们需要先从gitH ...
- 如何删除GitHub仓库里的文件夹(配图详解)
更多干货推荐可以去牛客网看看,他们现在的IT题库内容很丰富,属于国内做的很好的了,而且是课程+刷题+面经+求职+讨论区分享,一站式求职学习网站,最最最重要的里面的资源全部免费!!!点击进入------ ...
- iOS利用cocoapods 和GitHub组件化序Day1
1.安装cocoapod 遇到的问题 现在镜像源坑网上代码 --add https://ruby.taobao.org/ --remove https://rubygems.org/ 复制代码 这个是 ...
- 如何解决GitHub仓库README文件插入图片无法显示的问题
你可能遇到过github仓库中README.md文件中插入本地的图片后,无法显示的问题 这是因为github无法访问本地路径,其实我们可以把图片传到自己的仓库里,一劳永逸! 所以:
- Github的README中插入图片,Github仓库项目主页显示图片
Github仓库主页的 README.md 支持 MarkDown 文本,也支持图片显示.显示图片需要提供<img>标签,这个链接可以位于其他服务器上,也可以是GitHub自身的仓库文件. ...
最新文章
- php中介模式,中介者模式(Mediator pattern)详解及PHP实现
- 贪心 ---- C. Anu Has a Function位运算+贪心证明
- 纯真IP地址数据库qqwry.dat解析
- GraphPad Prism 9 如何一次处理多张图表?
- 全国计算机等级考试题库二级C操作题100套(第59套)
- 友盟U-share sdk 分享的接入(支持Android及IOS)
- 在Hibernate的session中同时有两个相同id的同类型对象,修改失败
- java学习(37):二维数组
- RFC函数的初步使用-同步
- python的print输出_python中的print()输出
- maven本地仓库中存在jar包,但编译不成功,显示jar包不存在
- 拓端tecdat|R语言指数加权模型EWMA预测股市多变量波动率时间序列
- top conference in AI
- 汉罗塔python_基于Python的汉诺塔算法
- MATLAB全局变量
- APP加固新方向——混淆和瘦身
- Logisticregression学习
- vmware模板机创建及标题快照克隆(非常详细)
- list_ndarray_csr_lil占用空间比较
- sap 标准委外和工序委外_SAP委外加工
热门文章
- matlab验证费根鲍姆常数,费根鲍姆常数
- matlab验证费根鲍姆常数,费根鲍姆常数(混沌理论和非线性)
- FIR数字滤波器设计
- 初识Linux(1):入门简介、基础指令
- 串口调试助手源代码 qt编写 带协议解析 帧判断 通信数据保存等功能
- java 视频压缩转码_java实现视频压缩转码
- 基于51单片机的简易计算器的实现
- vue2项目复习01-关闭elint检校,src文件别名,路由传参的对象写法,代理解决跨域问题,nprogress,vuex状态管理库,store的模块式开发,节流与防抖,编程式导航+事件委托路由跳转
- 坚石加密锁应用方法技巧简介
- MySQL 如何定时备份数据库