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
图像

链接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 ...
随机推荐
- 使用 Rx 中预定义的 Subject
看到一幅有趣的关于 Rx 学习的图,想知道学习 Rx 的学习曲线?不,是峭壁! 我们可以直接通过 Rx 的 Observer 来创建 Observable 对象. 但是,使用这种方式往往比较复杂,在特 ...
- dev gridcontrol把event事件转换成命令
可以通过继承gridcontrol的形式来实现 定义DataGridDoubleClickCommand依赖属性 class MyGridControl : GridControl { ...
- 如何运用xp_cmdshell 执行多行cmd命令
因为需要利用sql 脚本调用外部程序,所以尝试xp_cmdshell 命令,发现其默认只能执行一行命令,最后找到了下面方法: 将多行cmd 命令处理成bat文件,然后直接利用所在路径+文件来执行: ...
- NGINX----源码阅读---sources配置脚本
/auto/sources 本文件主要用于对源文件环境变量进行初始化,主要包括:.c和.h文件. 对应变量类型有*_MODULES.*_INCS.*_DEPS等. # Copyright (C) Ig ...
- POJ 3507 Judging Olympia
小技巧 判断 全部为零 用sign和所有元素依次取或 排除最大项和最小项 直接排序后取中间的四个元素 http://poj.org/problem?id=3507 1 #include <ios ...
- Zookeeper单机版安装(CentOS 7环境下)
一.环境操作系统和软件版本介绍 1.环境操作系统为CentOS Linux release 7.2.1511 (Core) 可用cat /etc/redhat-release查询 2.软件版本 Zoo ...
- CodeForces 670D Magic Powder
二分. 二分一下答案,然后验证一下. #pragma comment(linker, "/STACK:1024000000,1024000000") #include<cst ...
- 使用python之环境管理
情景1:不同python版本的管理 同一电脑上的多个python版本之前的管理,为了突出问题的普遍存在,下面是有人在segmentfault上提的问题. 摘自:http://segmentfaul ...
- 《Intel汇编第5版》 汇编调用子过程
一.Call和Ret指令 二.在子过程中需要自己保存可能会修改掉的寄存器值,这里可以使用USES伪指令来生成 三.一个数组求和的汇编例子 TITLE Call a Proc Demo INCLUDE ...
- Tomcat多域名的配置
有时候我们有好几个项目需要发布在同一个tomcat服务器上,每个项目有不同的域名.这就需要在tomcat里配置多域名,添加多个虚拟主机. 主要在server.xml里面设置: 在<Engine& ...