您的位置:首页 > 编程语言

Github Makedown 语法入门

2017-08-09 15:49 204 查看
GitHub上创建GitHub项目,会包含了一个 README.md 文件,此文件编辑就会用到Markdown本文将详细介绍Markdown文件(md文件)的语法。 本文示例开源项目,请见GitHub:https://github.com/mimvp/mimvp-markdown-syntax 1. 新建GitHub项目文本以米扑科技的项目库为例:mimvp新建项目链接:https://github.com/organizations/mimvp/repositories/new

2. 查看创建项目mimvp-markdown-syntax

3. 下载编辑 README.md 0) 克隆项目到本地https://github.com/mimvp/mimvp-markdown-syntax.git编辑好README.md文件后,再提交上传到GitHub,这种方式效率低。 推荐一种更快捷的编辑README.md方式,直接在Github上编辑(推荐)a)点击 README.md文件b)点击下图红框,直接编辑

1)Markdown 标题markdown 支持两种标题的语法:Setext 和 atx 形式,两者也可以结合使用,效果更好!a)Setext 形式用底线的形式,利用 === (最高阶标题)和 ----- (第二阶标题)Markdown 语法:
Markdown 结果:

b)atx 形式用#号标识标题,最多六级标题(不支持七级、八级等标题,会直接显示出文字)Markdown 语法:
Markdown 结果:

2)Markdown 代码块代码块,以大于号(>)开头。若末尾不加换行符<br/>,则所有文字会连接在一起不会换行。Markdown 语法:
Markdown 结果:

3)Markdown 引用块引用块,以特殊引号(`)开头。注意:不是单引号,而是特殊引号,在键盘左上角的“esc”左下方的那个按键Markdown 语法:
Markdown 结果:

4)Markdown 代码高亮代码高亮,以特殊引号(`)开头,并跟上代码语言,例如:python、java、javascript、ruby、perl、go、c、c++、bash等。注意:不是单引号,而是特殊引号,在键盘左上角的“esc”左下方的那个按键Markdown 语法:
Markdown 结果:

5)Markdown 字体加粗* 或 _,表示斜体** 或 __,表示粗体~~ 表示删除线Markdown 语法:
Markdown 结果:

6)Markdown 无序列表*(星号) +(加号) - (减号)表示无序列表Markdown 语法:
Markdown 结果:

7)Markdown 有序列表直接用1. xxx 2. xxx 3. xxx 编辑Markdown 语法:
Markdown 结果:

8)Markdown 插入链接Markdown 插入链接,有两种方式:方式1) [mimvp.com](http://mimvp.com) 方式2)<a target="_blank" href="http://mimvp.com">mimvp.com</a> (推荐)Markdown 语法:
Markdown 结果:

9)Markdown 插入图片Markdown 插入图片有两种方式:方式1) ![mimvp-logo.png](./mimvp-logo.png)方式2) <img src="./mimvp-logo.png" title="mimvp-logo.png" /> Markdown 语法:
Markdown 结果:

10)Markdown 表格Makrdown 支持table表格,语法跟wiki类似。同时,也支持table标签方式1Markdown 语法:
Markdown 结果:

方式2Markdown 语法:
Markdown 结果:

11)Markdown 多选项多选项,结合了多种元素,如无序列表减号(-),方括号等Markdown 语法:
Markdown 结果:

12)Markdown emoji表情 Markdown 语法:
Markdown 结果:

13)Markdown diff 高亮对比diff 语法是代码高亮语法的一种,以 `+ `开头表示新增,`- `开头表示删除。Markdown 语法:
Markdown 结果:

14)Markdown 其它知识知识1: [回到顶部](#readme)知识2: 版本符号 ©Markdown 语法:
Markdown 结果:

15)Markdown 版权格式一般开源项目,末尾会追加一些开原作者的信息,例如米扑科技的作者信息如下,供参考。Markdown 语法:
Markdown 结果:

本文Markdown示例,请见米扑科技的 GitHub:https://github.com/mimvp/mimvp-markdown-syntax
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: