Github上Markdown基本语法
基础写作和语法格式
本篇文章的内容来源于Github的基础写作帮助.如果在观看时有什么问题,可以直接查阅源文件。另外需要说明的是Git对Markdown的支持增加了一些扩展功能,因此在Git上可以渲染的Markdown语法并不一定在仅支持标准Markdown语法的平台上运行。
本文后续还有对GitHub上Markdown语法的高级应用的介绍。
标题
Markdown中标题如果想定义一个标题,可以在前面加上#(或者用#将标题括起来)。1-6个#分别表示1-6级标题。有的编辑器需要在#和正文之间加一个空格(Atom),有的编译器不用(MarkdownPad),为了保持同一建议都加上空格。
# 标题一
#标题一#
## 标题二
显示结果:
标题一
标题一#
标题二
文本样式
Markdown支持4中文本样式,分别是:加粗、斜体、删除线和加粗且斜体。
| 样式 | 关键字 | 快捷键 | 样例 | 输出 |
|---|---|---|---|---|
| 加粗 | ** **或者__ __ |
command/control+b | **加粗文本** |
加粗文本 |
| 斜体 | * *或者_ _ |
command/control+i | _斜体文本_ |
斜体文本 |
| 删除线 | ~~ ~~ |
无 | ~~删除线~~ |
删除线 |
| 加粗且斜体 | ** **和_ _ |
无 | **这个是:_加粗且斜体_** |
_这个是_加粗且斜体 |
这篇随笔也是用Markdown写的,预览了一下发现博客园不支持加粗且斜体渲染。于是乎我截了一张我用Atom渲染后的结果

表中的快捷键是几乎所有编辑器都支持的,“无”是没有统一支持的要求,也许有的编辑器支持。command是mac上的键。
引用文本
引用文本的关键字是>。
下面是一个引用:
>大家好!我是一个引用。
输出结果:
下面是一个引用:
大家好!我是一个引用
引用代码
引用代码有两种形式,一种是在文本中引入一个代码:使用一个倒引号`括起来;另一种是插入一段代码:使用三个倒引号```括起来(非标准Markdown语法,Atom中支持MarkdownPad中不支持)。
我需要在文中插入快捷键`ctrl+v`.
结果:
我需要在文中插入快捷键ctrl+v.
我需要引用一段代码:
``` c++
int a = 1;
int b = 2;
int c = a+b;
```
结果:
我需要引用一段代码:
int a = 1;
int b = 2;
int c = a+b;
上面可以直接在三个倒引号后面加入引用代码的语言类型。编辑器会对应的进行渲染。当然我们也可以直接使用一个tab或四个空格来表示我要插入一段代码(Atom中是2个tab)。
int a = 1;
int b = 2;
int c = a+b;
结果:
int a = 1;
int b = 2;
int c = a+b;
链接
Git编译器关于链接的使用加入了较多的扩展。这里仅介绍标准Markdown语法中的行内链接和参考链接。
下面是行内链接示例:
[链接到百度](https://www.baidu.com "百度")
结果:
下面是一个参考链接的示例:
[链接到百度][1]
[链接到Google][2]
[还是链接到百度][1]
[1]:https://www.baidu.com
[2]:https://www.google.com
结果:
参考链接中的标号1,2不仅仅可以是数字,也可以是字母或它们的组合。
同时链接也支持相对路径,./表示当前目录,../表示前一级目录。这里也建议在编写文档时,不同文档之间的关联采用相对路径的形式。
列表
我们可以使用*,+,-或者数字作为列表的关键字。同时列表也支持嵌套的形式。
- 主列表1
- 主列表2
1. 次列表1
2. 次列表2
+ 主列表3
结果:
- 主列表1
- 主列表2
- 次列表1
- 次列表2
- 主列表3
任务列表
任务列表是Git对标准Markdown语法的扩展,并不是标准Markdown语法。因此MarkdownPad不会对该语法进行渲染。但是使用Atom就会对该语法进行渲染。
- [x] 任务列表1
- [ ] 任务列表2
- [ ] 任务列表3
结果:
- [x] 任务列表1
- [ ] 任务列表2
- [ ] 任务列表3
使用表情
Git中的Markdown语法扩展中包括了一些表情包。这个表情包语法依然可以通过Atom进行渲染。由于不是标准的Markdown语法不能通过MarkdownPad渲染。
表情一::+1:,表情二::o:
表情一:
Github上Markdown基本语法的更多相关文章
- GitHub上Markdown语法的高级应用
高级语法格式 本篇的内容来源于Github使用高级格式写作.如果在观看时有什么问题,可以直接查阅源文件.另外需要说明的是Git对Markdown的支持增加了一些扩展功能,因此在Git上可以渲染的Mar ...
- GitHub上README写法暨markdown语法解读
原文: GitHub上README写法暨markdown语法解读 自从开始玩GitHub以来,就 越来越 感觉它有爱.最近对它的 README.md 文件颇为感兴趣.便写下这贴,帮助更多的还不会编写R ...
- 【Markdown】Writing on Github - 在GitHub上写作
Writing on GitHub https://github.com/shalliestera/Writing-on-GitHub-Chinese-Translation Markdown 基本语 ...
- 原来Github上的README.md文件这么有意思——Markdown语言详解
转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的REA ...
- 【转录】原来Github上的README.md文件这么有意思——Markdown语言详解
之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解.但是在看到别人写的项目的README.md里 ...
- GitHub支持的Markdown语法 GitHub Flavored Markdown
GitHub支持的Markdown语法,简称GFM.相比标准的Markdown(SM)语法,有少数几个区别,并添加了新的功能. 本位参考 GitHub Flavored Markdown 撰写.有兴趣 ...
- 写markdown用于Github上readme.md文件
Markdown 文档地址 http://pan.baidu.com/s/1o6nu9To Markdown还有一系列衍生版本,用于扩展Markdown的功能(如表格.脚注.内嵌HTML等等),这些功 ...
- 怎么用Markdown在github上写书,并用pages展示
怎么用git写书 安装环境 第一步 安装node npm 先检测自己电脑是否安装了node npm # 查看 node 版本 node -v # 查看 npm 版本 npm -v 复制代码 如果成功打 ...
- github上建站和使用markdown写文章
积累了那么久,终于成功搭建了github上的个人网站.虽然方法有点巧妙.不是还是建成了 同时学会用markdown写基本的文章.感觉还可以.附带我的github上的静态页面网站的网址:http://z ...
随机推荐
- spring使用中ModelAttribute的内容被覆盖
在前台以get方式向后台提交数据: 后台接收: 后台接收参数的时候,由于user里面也有一个属性为id,后台在接收参数的时候,User里面的id会被重新赋值,这是一个大坑.如果后续继续用User来做操 ...
- 大数据_Kafka_Kafka自动创建不存在的Topics / 删除已存在的Topics
大数据_Kafka_Kafka自动创建不存在的Topics / 删除已存在的Topics 2016年10月11日 18:22:59 高达一号 阅读数:8655 版权声明:本文为博主原创文章,未经博 ...
- Spring-Cloud的版本是如何定义的
https://blog.csdn.net/peterwanghao/article/details/79633275 Finchley 与 Spring Boot 2.0.x, 兼容,不支持 Spr ...
- php原样输出被编译过的html(适用于一些保存编辑器的内容)
有时候有些编辑器写进数据库时尖括号或双引号被编译过,这时候输入来就是处理一下,不然得不到原样的 输入用 html_entity_decode($content)就可以了,有些直接存完整html的,输 ...
- 新手必看ES6基础
ES6 基础 一.新的变量声明方式 let/const 与var不同,新的变量声明方式带来了一些不一样的特性,其中最重要的两个特性就是提供了块级作用域与不再具备变量提升. 通过2个简单的例子来说明这两 ...
- python远程操作服务器
python远程控制 标签(空格分隔): 远程Linux python远程控制:方案: Paramiko Pexpect(主要Linux机器) 安装Paramiko pip install param ...
- msf客户端渗透(二):PDF漏洞、恶意网站、flash漏洞、IE漏洞、java漏洞、android漏洞、VBScript感染payload
这个漏洞利用只在XP上有效 利用pdf漏洞利用payload exploit生成一个pdf文件 传到被攻击机上 启动msf侦听 exploit -j XP上双击运行这个pdf时,kali获取到一个sh ...
- Ambertools15安装(详细)
这篇博文专门讲述 Ambertools15的安装方法,尽管Ambertools16版本已经正是发行了,但两者在安装方式上没有任何区别.比较偏爱Ambertools15的原因主要还是在容量方面(230M ...
- Maven 标签
scope 1.compile:默认值 他表示被依赖项目需要参与当前项目的编译,还有后续的测试,运行周期也参与其中,是一个比较强的依赖.打包的时候通常需要包含进去 2.test:依赖项目仅仅参与测试相 ...
- python if __name__ == 'main' 的作用和原理()
相信初学者在学习Python的过程中,不可避免的总会遇到 if __name__ == 'main'语句,虽然一直知道它的作用,但是可能一直比较模糊,今天菜鸟分析就与大家一起举例说说我的理解. 举个例 ...