MarkDown编写规范指南
Markdown 编写规范指南
简介:
Markdown的目标是实现「易读易写」,成为一种适用于网络的「书写语言」。
一份使用Markdown格式撰写的文件可以直接以纯文本发布,它的最大灵感来源其实是纯文本电子邮件的格式。
Markdown的语法由一些符号所组成,其作用一目了然。
比如:在文字两旁加上星号,看起来就像强调。
Markdown兼容HTML语法并且会将<和&等符号进行自动转换,这项特性可以让我们很容易地用Markdown写HTML code。
目录
基础语法
标题
# 这是 <h1> 标签
## 这是 <h2> 标签
###### 这是 <h6> 标签
强调
*这里文字是斜体*
_这里文字也是斜体_
**这里文字是粗体**
__这里文字也是粗体__
_你也 **可以** 这样组合他们_
实际效果:
这里文字是斜体
这里文字也是斜体
这里文字是粗体
这里文字也是粗体
你也 可以 这样组合他们
列表
无序列表
+ 条目 1
+ 条目 2
+ 条目 2a
+ 条目 2b
实际效果:
- 条目 1
- 条目 2
- 条目 2a
- 条目 2b
有序列表
1. 条目 1
2. 条目 2
3. 条目 3
+ 条目 3a
+ 条目 3b
实际效果:
- 条目 1
- 条目 2
- 条目 3
- 条目 3a
- 条目 3b
图像
![Logo](/image/logo.png)
链接1
[BaiDu](http://www.baidu.com)
链接2
我用上面那种方式进行连接,发现点击的时候是在当前页面打开的,所有就又整理了下可以新窗口打开的方法:
效果:点击打开百度首页
方法是:<a href="https://www.baidu.com/" target="_blank">点击打开百度首页</a>
引用
就像邵林说的:
> 我们活在未来
> 现在只是我们的过去
实际效果:
就像邵林说的:
我们活在未来
现在只是我们的过去
内敛代码
我想你可以在这里
使用 `<addr>` 元素
实际效果:
我想你可以在这里
使用 <addr>
元素
Github 风味的 Markdown
Github 定义了一些额外的语法,让文档编写变得更加简单和优雅,也是我们推荐使用的
语法高亮
在文章中嵌入不同语言的代码,并自动高亮关键字和语法错误
```javascript
function fancyAlert(arg) {
if(arg) {
$.facebox({div: '#foo'})
}
}
\`\`\`
实际效果:
function fancyAlert(arg) {
if(arg) {
$.facebox({div: '#foo'})
}
}
任务列表
+ [x] 这是已完成的项目
+ [ ] 这是未完成的项目
实际效果:
- [x] 这是已完成的项目
- [ ] 这是未完成的项目
删除线
~~删除了的项目~~
实际效果:
删除了的项目
表格
每一列通过管道符 |
分割,表头通过 -
标记即可
第一个表头 | 第二个表头
---------- | ---------
第一行第一个 | 第一行第二个
第二行第一个元素 | 第二行第二个
实际效果:
第一个表头 | 第二个表头 |
---|---|
第一行第一个 | 第一行第二个 |
第二行第一个元素 | 第二行第二个 |
超链接
请为 Git 提交的 SHA-1 hash 值,issue #编号
设置超链接
MarkDown编写规范指南的更多相关文章
- Markdown 编写规范
说明及目的 作为一个在博客园混迹了俩三年的人,一直在这里看别人的博客,现在准备开始写自己的博客,目的呢,就是一下几点吧: 项目过程中的历史经验教训积累记载,吃一堑长一智,不想在同一个坑掉进去好几次 学 ...
- Markdown 编辑器使用指南
Markdown 编辑器使用指南 1.快捷键 加粗: Ctrl/Cmd + B 标题: Ctrl/Cmd + H 插入链接: Ctrl/Cmd + K 插入代码: Ctrl/Cmd + Shift + ...
- 最全面的 Android 编码规范指南
最全面的 Android 编码规范指南 本文word文档下载地址:http://pan.baidu.com/s/1bXT75O 1. 前言 这份文档参考了 Google Java 编程风格规范和 Go ...
- css编写规范最佳实践
最初,在编写CSS的时候,我们往往想到哪儿就写到哪儿,它们之间的关联性和有序性并不在考虑之中.但随着代码量的增加,亦或是多人共同开发,CSS的编写规范变得重要起来了.本文通过三个方面,总结出CSS编写 ...
- Markdown快速上手指南
Markdown快速上手指南 1.Markdown介绍 markdown可以实现快速html文档编辑,格式优没,并且不需要使用html元素. markdown采用普通文本的形式,例如读书笔记等易于使用 ...
- JavaScript编码规范指南
前言 本文摘自Google JavaScript编码规范指南,截取了其中比较容易理解与遵循的点作为团队的JavaScript编码规范. JavaScript 语言规范 变量 声明变量必须加上 var ...
- 20151009 C# 第一篇 程序编写规范
20151009 程序编写规范 1. 代码书写规则: 1).尽量使用接口,然后使用类实现接口. 2).关键语句写注释 3).避免写超过5个参数的方法,如果要传递多个参数,则使用结构 4).避免代码量过 ...
- .NET代码编写规范 整理
.NET代码编写规范 整理 .NET代码编写规范 - [ASP.NET] 2009-02-26 | Tag: 版权声明:转载时请以超链接形式标明文章原始出处和作者信息及本声明 http://lensp ...
- 代码编写规范说明书(c#.net与asp.net)
代码编写规范说明书(c#.net与asp.net) 目 录1 目的2 范围3 注释规范3.1 概述3.2 自建代码文件注释3.3 模块(类)注释3.4 类属性注释3.5 方法注释3.6 代码间注释4 ...
随机推荐
- Laravel5.3 流程粗粒度分析之bootstrap
从laravel入口文件index里面外面不难定位到Illuminate\Foundation\Http\Kernel的handle方法,同样也不难发现handle方法的核心是 $response = ...
- 为什么用Object.prototype.toString.call(obj)检测对象类型?
最近做了做一些js面试25 Essential JavaScript Interview Questions*,其中第一道是:使用typeof bar === "object"检测 ...
- 数据库开启gtid时,需要注意的问题
1.slave不能执行任何sql,包括超级用户2.read_only=on,这个必须要开启,避免业务执行sql3.保证当前slave的事务id为1 当slave同步出现问题时,手动跳过,需要考虑的问题 ...
- 数据挖掘_wget整站下载
你应该了解的所有wget命令 翻译自All the Wget Commands You Should Know 如何下载整个网站用来离线浏览?怎样将一个网站上的所有MP3文件保存到本地的一个目录中?怎 ...
- java 访问后台方法顺序混乱
今天遇到后台接值顺序混乱的问题. 环境:前台ajax请求后台方法.前台页面会频繁访问这个ajax. 现象:访问后台方法的顺序混乱. 怎么发现的问题:数量小访问没有问题,今天压力测试发现的问题. 解决办 ...
- [ An Ac a Day ^_^ ][kuangbin带你飞]专题六 最小生成树 POJ 2031 Building a Space Station
最小生成树模板题 注意最后输出用%f (从C99开始%f已经不能用于输出double 即 输入用%lf 输出用%f) #include<cstdio> #include<algori ...
- USACO 3.2 Factorials
Factorials The factorial of an integer N, written N!, is the product of all the integers from 1 thro ...
- Angular React 和 Vue的比较
Angular(1&2),React,Vue对比 一 数据流 数据绑定 Angular 使用双向绑定即:界面的操作能实时反映到数据,数据的变更能实时展现到界面. 实现原理: $scope变量中 ...
- mysql中datetime和timestamp的区别
原文地址:http://database.51cto.com/art/200905/124240.htm 相同 显示 TIMESTAMP列的显示格式与DATETIME列相同.换句话说,显示宽度固定在1 ...
- centos7如何安装pandoc
1 Install stack 1.1 Add the appropriate source repository: curl -sSL https://s3.amazonaws.com/downlo ...