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. 条目 1
  2. 条目 2
  3. 条目 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编写规范指南的更多相关文章

  1. Markdown 编写规范

    说明及目的 作为一个在博客园混迹了俩三年的人,一直在这里看别人的博客,现在准备开始写自己的博客,目的呢,就是一下几点吧: 项目过程中的历史经验教训积累记载,吃一堑长一智,不想在同一个坑掉进去好几次 学 ...

  2. Markdown 编辑器使用指南

    Markdown 编辑器使用指南 1.快捷键 加粗: Ctrl/Cmd + B 标题: Ctrl/Cmd + H 插入链接: Ctrl/Cmd + K 插入代码: Ctrl/Cmd + Shift + ...

  3. 最全面的 Android 编码规范指南

    最全面的 Android 编码规范指南 本文word文档下载地址:http://pan.baidu.com/s/1bXT75O 1. 前言 这份文档参考了 Google Java 编程风格规范和 Go ...

  4. css编写规范最佳实践

    最初,在编写CSS的时候,我们往往想到哪儿就写到哪儿,它们之间的关联性和有序性并不在考虑之中.但随着代码量的增加,亦或是多人共同开发,CSS的编写规范变得重要起来了.本文通过三个方面,总结出CSS编写 ...

  5. Markdown快速上手指南

    Markdown快速上手指南 1.Markdown介绍 markdown可以实现快速html文档编辑,格式优没,并且不需要使用html元素. markdown采用普通文本的形式,例如读书笔记等易于使用 ...

  6. JavaScript编码规范指南

    前言 本文摘自Google JavaScript编码规范指南,截取了其中比较容易理解与遵循的点作为团队的JavaScript编码规范. JavaScript 语言规范 变量 声明变量必须加上 var  ...

  7. 20151009 C# 第一篇 程序编写规范

    20151009 程序编写规范 1. 代码书写规则: 1).尽量使用接口,然后使用类实现接口. 2).关键语句写注释 3).避免写超过5个参数的方法,如果要传递多个参数,则使用结构 4).避免代码量过 ...

  8. .NET代码编写规范 整理

    .NET代码编写规范 整理 .NET代码编写规范 - [ASP.NET] 2009-02-26 | Tag: 版权声明:转载时请以超链接形式标明文章原始出处和作者信息及本声明 http://lensp ...

  9. 代码编写规范说明书(c#.net与asp.net)

    代码编写规范说明书(c#.net与asp.net) 目 录1 目的2 范围3 注释规范3.1 概述3.2 自建代码文件注释3.3 模块(类)注释3.4 类属性注释3.5 方法注释3.6 代码间注释4 ...

随机推荐

  1. dom4解析xml格式文件实例

    以下给4种常见的xml文件的解析方式的分析对比: DOM DOM4J JDOM SAX 解析XML文件的几种方式和区别答: Dom解析 在内存中创建一个DOM树,该结构通常需要加载整个文档然后才能做工 ...

  2. 真的了解js生成随机数吗

    由js生成一切随机数的基础都是Math.random()这个方法,这个方法比较特别,生成的随机数落在的区间是[0,1),进行一次操作的话,js只能生成一个类似于[n,m)这样,左闭右开的区间.所以当有 ...

  3. C++ 头文件系列(stack)

    简介 该头文件只含有一个类模版stack, 它实现栈的概念,是一个容器适配器(说实话,在写这篇随笔之前我都不知道有这么个类模版). 栈 栈只有一个重要的特性: LIFO(last-in first-o ...

  4. vue组件,撸第一个

    实现此例您可以学到: vue-cli的基本应用 父组件如何向子组件传递值 单文件组件如何引入scss v-on和v-for的基础应用 源码下载 一.搭建vue开发环境 更换镜像到cnpmnpm ins ...

  5. Python自动化开发-基础语法

    1.编码 计算机只能处理数字,如果要处理文本,就必须先把文本转换为数字才能处理.解决思路:数字与符号建立一对一映射,用不同数字表示不同符号. ASCII(American Standard Code ...

  6. Andy的生活

    Andy是一个善良的男孩,希望优雅地生活. 现实是残酷的. 现实是,Andy像狗一样活着. Andy犯的错是,错误地认为狗一样的生活将在高考结束的那一刻结束. 大学四年时间根本没有静下心来学习,却在生 ...

  7. centos6.4、6.5、7.0环境下载及安装

    centos6.4.6.5.7.0下载地址: http://www.cnblogs.com/zhwl/p/3657958.html或 http://www.linuxdown.net/CentOS/2 ...

  8. SpringMVC实现注解式权限验证(转)

    SpringMVC学习系列(9) 之 实现注解式权限验证   对大部分系统来说都需要权限管理来决定不同用户可以看到哪些内容,那么如何在Spring MVC中实现权限验证呢?当然我们可以继续使用serv ...

  9. 【原生js】js动态添加dom,如何绑定事件

    首先要明白浏览器在加载页面的时候是按顺序来加载的,这样以来就很清楚了,js动态添加dom以后,这些dom并没有绑定事件,这个时候最简单的一个办法就是:将绑定事件的方法封装到一个函数A中,在动态添加完d ...

  10. 在GNU/Linux下使用Lilypond排版简谱

    尽管GNU/Linux并非无所不能,但确实能在很多时候提供免费.开放的解决方案.这两天我想做一个简谱,在网上搜索乐谱排版软件,发现了基于GPL协议的Lilypond软件.只不过Lilypond是用来做 ...