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 ...
随机推荐
- 创建DLL动态链接库——声明导出法
DLL声明导出法:是通过使用__declspec(dllexport),添加到需要导出的函数前,进行声明. 头文件定义如下(OPdll.h): 源文件定义如下(OPdll.cpp): 通过以上两个文件 ...
- Android文档 学习目录
Building Your First App After you've installed the Android SDK, start with this class to learn the b ...
- react ES5 与ES6的写法
ES5var React = require('react'); var ReactDOM = require('react-dom'); // 定义组件 var HelloMessage = Rea ...
- 2018面向对象程序设计(Java)第1周学习指导及要求
2018面向对象程序设计(Java) 第1周学习指导及要求(2018.8.24-2018.9.2) 学习目标 了解课程上课方式及老师教学要求,掌握课程学习必要的软件工具: 简单了解Java特点及历 ...
- SpringBoot @Aspect
1.添加maven依赖注解 <!--springBoot的aop--> <dependency> <groupId>org.springframework.boot ...
- 解题1(Suduku)
题目描述 问题描述:数独(Sudoku)是一款大众喜爱的数字逻辑游戏.玩家需要根据9X9盘面上的已知数字,推算出所有剩余空格的数字,并且满足每一行.每一列.每一个粗线宫内的数字均含1-9,并且不重复. ...
- 两种创建Observable的方法(转)
转自:http://blog.csdn.net/nicolelili1/article/details/52038211 Observable.create() create()方法使开发者有能力从头 ...
- :after伪类+content经典应用举例
:after伪类+content 清除浮动的影响 .box{padding:10px; background:gray;} .l{float:left;} <div class="bo ...
- vue confirm确认
this.$confirm('您确定删除吗?').then(_ => { do something ... (确认) }).catch(_ => { do something ... (取 ...
- 第十一章 串 (b1)串匹配