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. Python 函数简介 之二

    1.当函数有多个返回值时, 其多个返回值将以元组的形式出现 def test1(): print("in the test1") return 'end' def test2(): ...

  2. c语言中细节注意(初级)

    /* 编写如下函数,不使用下标运算符,返回字符串str中字符c的个数 (若不存在则为0). */ #include <stdio.h> int str_chnum(const char * ...

  3. Eclipse连接MySQL出现Server time zone is unrecognized错误

    错误代码: The server time zone value '?й???????' is unrecognized or represents more than one time zone. ...

  4. 移动开发meta集合【精】

    以下是开发中经常用到的meta标签 1.移动webAPP的Meta 用法: <meta content="width=device-width, initial-scale=1.0, ...

  5. centos下安装Jenkins轻松搞定

    jenkins安装步骤如下: 命令:yum -y list java* yum -y install java-1.7.0-openjdk.x86_64                         ...

  6. C# CodeHelper

    using System; using System.Collections.Generic; using System.Drawing; using System.Linq; using Syste ...

  7. http://www.cnblogs.com/ycxyyzw/archive/2012/07/31/2616951.html

    http://www.cnblogs.com/ycxyyzw/archive/2012/07/31/2616951.html

  8. 【Android】策略模式封装百度地图路线规划模块

    百度地图的Demo里有个路线规划的功能,但是,这个功能和Activity耦合性太高,所以需要单独抽离出路径规划功能,进行"解耦". 注:由于项目原因,本文只针对驾车路线规划进行封装 ...

  9. QLibraryInfo

        读取 qt.conf 文件, 获取 Qt Library 的信息.     通常会在以下三个路径查找conf文件:         :/qt/etc/qt.conf(使用资源系统时)      ...

  10. swift 经典代码收集 和 赏析

    代码1:protocol PickableEnum { var displayName: String { get } var permanentID: String { get } static v ...