用markdown语法写GitHub上README文件

这篇文章是本人平时的一些笔记,可能会有很多人写过相关的东西,而且更为全面。目的只是分享一些自己平时的东西,勿喷!!!!

README文件

README文件可能大家都不会陌生,在我们上传一些自己的工程文件到GitHub时,附加的一个说明文档,会显示在仓库的详情中。使用markDown语法编写可以让其看起来更加清晰明朗一些。

具体的相关语法说明

readme文件的创建和编辑在这里就不多介绍了,相信使用过git的朋友们应该不会陌生。下面是一些常用的语法:

1.标题

首先是大标题,大标题是在作为标题的文字下面添加=号,个数不限;
其次是中标题,中标题在作为标题的文字下面添加-号,个数不限;
最后是各级小标题,分为六级,#号开头 ,每多一级多一个#号,比如:一级标题是#,二级标题是##,以此类推下去。下面是相关的效果展示:

大标题

中标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

+++++++手动分割线+++++++++

2.文本

首先是普通文本,文本主要是换行符,"< br >"(去掉空格)或者是双空格加回车,如下:
这是一条可以换行的话,
这里是使用换行符换行。
这里是使用双空格加回车换行

然后是单行和多行文本, 使用两个Tab符实现单行文本;多行文本和单行文本异曲同工,只要在每行行首加两个Tab,比如
hello,swift
亲爱的领导:
你好!
再见

最后是文本的格式化和插入:

字体高亮:

把需要设置的字体用包围,是Tab上方,数字1左边的按键。如下:
窗前明月光,疑是上霜

粗体和斜体:

用两个 星号 包含一段文本就是粗体的语法,用一个星号包含一段文本就是斜体的语法。
头望明月,低头思故乡

引用:

在引用的句子前面加上 > 号即可:

静夜思
窗前明月光,
疑是地上霜。
举头望明月,
低头思故乡。

文本超链接:

格式是: [ 要显示的文字 ]( 链接的地址 ** "悬浮显示")** ,还可以给他加上一个鼠标悬停显示的文本,就像css中的hover属性。如下:
百度一下

列表:

无序列表的话,你只需要在文字前面加上 - + 空格 就可以了,有序列表的话就在前面加上1. 2. 3等;圆点符的话,加上*号。如果想要分级的话在每一级前面加个tab键即可, 如下:
无序列表:

  • 无序1
  • 无序2
  • 无序3

有序列表:

  1. 无序1
  2. 无序2
  3. 无序3

圆点符:

  • 文本
  • 文本
  • 文本

分级列表:

  • 文本
    • 文本
      • 文本
插入图片,添加图片链接

叹号! + 方括号[ ] + 括号( ) 其中括号里是图片的URL。在方括号里可以加入一些 标识性的信息


baidu
代码引用

这个对开发者可能比较有用处:
需要引用代码时,如果引用的语句只有一段,不分行,可以用 (tab键上面的,1键旁边的键位)将语句包起来。如果引用的语句为多行,可以将三个(tab键上面的,1键旁边的键位)置于这段代码的首行和末行。
var name = "hello , wrold"

if let removedValue = airports.removeValueForKey("DUB"){
    print("The removed airport's name is (removedValue).")
} else {
    print("The airports dictionary does not contain a value for DUB.")
}// prints "The removed airport's name is Dublin Airport." 

结语:

简书也自带markdown功能,编辑起来很方便。上面只是一些简单的操作,还有一些复杂的语法规则如果平时用到的话,可以自行在网上查询。markdown对撰写blog还是蛮实用和重要的!!!希望能帮到大家。。加油!!!

这里有一篇参考的博客和一个应用实例的链接:

献给写作者的 Markdown 新手指南
REDEME实例

推荐阅读更多精彩内容