Markdown 语法文档

前言

Markdown 是一种轻量级标记语言,创始人为約翰・格魯伯(英语:John Gruber);

它允许人们 “使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML(或者 HTML)文档”;

这种语言吸收了很多在 电子邮件中已有的纯文本标记的特性;

—— 维基百科

Markdown 的部分标记有几种不同的符号,但是实现的效果都是相同的,所以文章中每种实现的效果我只写一种符号,一般都是方便且较常用的标记符号;

标题

# H1
## H2
### H3
#### H4

# 的数量代表标题的级别;

段落与格式

段落

我是第一段

我是第二段

段落之间加入空行实现换行效果,如无空行,换行符会转换成空格;

我是第一段
我是第二段

在前一段落末尾加上至少两个空格,也可实现换行;

字体格式

*斜体字体*
**加粗字体**
***加粗斜体***

段落两端加上对应数量 *(星号),即可实现以上三种效果;

删除线

~~删除线~~

段落两端加上 ~~ 即可实现 删除线 效果;

下划线

<u>下划线</u>

Markdown 语言中没有 下划线 标记,但是 Markdown 支持 HTML 标记,所以可以通过 HTML 的 <u> 标记实现 下划线 效果;

引用内容

单行引用

>时间就是生命,我的朋友

时间就是生命,我的朋友

多行引用

>多行引用如果需要换行
>可在两行之间添加空行
>
>或在换行前的行末添加两个空格

多行引用如果需要换行

可在两行之间添加空行

或在换行前的行末添加两个空格

嵌套引用

>时间就是生命,我的朋友
>>Yes!

时间就是生命,我的朋友

Yes!

列表

有序列表

1. 列表一
2. 列表二
1. 子列表一
2. 子列表二
3. 列表三
  1. 列表一
  2. 列表二
    1. 子列表一
    2. 子列表二
  3. 列表三

无序列表

- 第一种实现符号
+ 第二种实现符号
+ 嵌套列表
+ 嵌套列表
* 第三种实现符号
  • 第一种实现符号
  • 第二种实现符号

    • 嵌套列表
    • 嵌套列表
  • 第三种实现符号

TODO 列表

- [ ] TODO 1
- [ ] TODO 2
- [ ] TODO 2.1
- [x] TODO 2.2
- [x] TODO 3

博客园暂不支持 TODO 列表;

代码

行内代码

全选:`Ctrl` + `A`

全选:Ctrl + A

代码块

​```
我是代码块
​```
我是代码块

注:1、3 行的 ``` 就是代码块的实现符号;

代码高亮

​```C#
using System; class Markdown{ }
​```
using System;

class Markdown{ }

注:在行首 ``` 后加上代码语言的名字,即可实现对应的代码高亮;

邮箱

<address@email.com>

address@email.com

链接

内联链接

[Light's Note](https://www.cnblogs.com/Light-/ "Light's Note(可选)")

Light's Note

<https://www.cnblogs.com/Light-/>

https://www.cnblogs.com/Light-/

外联链接

[Light's Note][blog_Url]

[blog_Url]:https://www.cnblogs.com/Light-/ "Light's Note(可选)"

Light's Note

图片

内联图片

![我的头像](https://pic.cnblogs.com/avatar/1645312/20190418233348.png "Ligth's Note(可选)")

外联图片

![我的头像][png_url]

[png_url]:https://pic.cnblogs.com/avatar/1645312/20190418233348.png "Light's Note(可选)"

表格

使用 | 分隔单元格,- 分隔表头和其他行;

表头 | 表头
----- | -----
单元格 | 单元格
单元格 | 单元格
表头 表头
单元格 单元格
单元格 单元格

单元格对齐

:- :左对齐

:-: :居中

-: :右对齐

表头 | 表头 | 表头
:---- | :-: | ----:
左对齐 | 居中 | 右对齐
左对齐 | 居中 | 右对齐
表头 表头 表头
左对齐 居中 右对齐
左对齐 居中 右对齐

高级技巧

HTML 标记

Markdown 是一种标记语言,且同时兼容另一种标记语言 HTML (博客园暂只支持部分简单标记),所以我们也可以直接在文档中使用相关标记,例如:

<u> 下划线

<u>下划线文本</u>

下划线文本

<kbd> 键盘框

全选:<kbd>Ctrl</kbd> + <kbd>A</kbd>

全选:Ctrl + A(博客园暂不支持)

<i> 内嵌图标

<i class="icon-weibo"></i>

更多的图标和玩法可以参看 font-awesome 官方网站;(博客园暂不支持)

转义字符

Markdown 的占用了很多常用符号,如:*-~

如果我们写文档时需要显示这些符号,可以使用转义字符:\标记符号 转义为 普通符号 显示出来;

*斜体文本*
\*斜体文本\*

斜体文本

*斜体文本*

**加粗文本**
\*\*加粗文本\*\*

加粗文本

**加粗文本**

分隔符

---


使用至少三个 - (减号),加上一个空行,实现分隔符;

脚注

Light's Note 里面的文章真棒![^脚注标题]

[^脚注标题]: 是的,我也这么觉得~

Light's Note 里面的文章真棒![1]


  1. 是的,我也这么觉得~ ↩︎

Markdown 语法文档的更多相关文章

  1. 嵌入式 H264参数语法文档: SPS、PPS、IDR以及NALU编码规律

    // [h264编码出的NALU规律]// 第一帧 SPS[0 0 0 1 0x67] PPS[0 0 0 1 0x68] SEI[0 0 0 1 0x6] IDR[0 0 0 1 0x65]// p ...

  2. SQL 进阶视频课程。Udacity: Intro to Relational Databases和 PostgreSQL语法文档。

    Udacity: Intro to Relational Databases The syntax of the select statement with a where clause: selec ...

  3. Smali 语法文档

    可以选择保存成pdf格式,查询起来挺方便的 if v0==0 go cond_0 if-eqz v0, :cond_0   if v0!=0 go cond_0 if-nez v0, :cond_0 ...

  4. Markdown 语法和 MWeb 写作使用说明

    ---恢复内容开始--- # Markdown 语法和 MWeb 写作使用说明 Markdown 的设计哲学 Markdown 的目標是實現「易讀易寫」. 不過最需要強調的便是它的可讀性.一份使用 M ...

  5. Markdown语法和MWeb使用说明

    Markdown 语法和 MWeb 写作使用说明 开始写博客,首先熟悉一下Markdown,以前过看GitHub里的README.MD,感受到了这种文字排版的简洁美观. 写博客是一种有效的学习总结和分 ...

  6. 怎样在Linux下使用Markdown进行文档工作

    怎样在Linux下使用Markdown进行文档工作 在Linux系统中,编辑markdown能够用retext工具: sudo apt-get install retext retext Releas ...

  7. MARKDOWN使用文档

    ISSUE引用 引用当前项目内的ISSUE #1 markdown写法 #1 引用当前命名空间下的其他项目内的ISSUE projectname#1 sofa_ta#1 markdown写法 sofa ...

  8. 如何写Markdown格式文档

    Markdown Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯.它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档.这种语言吸收了很多在电子邮件中 ...

  9. 使用Markdown写文档

    转载于:http://blog.csdn.net/xiahouzuoxin/article/details/19752603 Markdown是一种网络书写语言,其目标是实现易读易写,且兼容HTML语 ...

随机推荐

  1. Docker for Windows 使用 VMware WorkStation

    一.前言 Docker for Windows 不同于 Docker Toolbox.Docker for Windows 对系统的要求至少为Windows 10专业版,因为它需要Hyper-V的支持 ...

  2. Java系列1 -- 浅谈面向对象

    也许每一个计算机专业的人,在大学学习java的时候,老师开始时都会说这么一句话,"Java是一门面向对象的语言".那么面向对象到底是什么,他有什么好处,或者他比其他流行的语言C/C ...

  3. ubuntu16.04如何安装搜狗输入法

    1 . 首先我们需要先来下载支持linux版本的搜狗输入法安装包,这里我们先查看下自己的ubuntu系统是什么版本的,这里我们可以在右上角的那个齿轮图标点击查看"系统设置",在里面 ...

  4. HTTP状态码的详细解释,供参考

    HTTP状态码详解 常用对照表 状态码 含义 100 客户端应当继续发送请求.这个临时响应是用来通知客户端它的部分请求已经被服务器接收,且仍未被拒绝.客户端应当继续发送请求的剩余部分,或者如果请求已经 ...

  5. Java 字符流文件读写

    上篇文章,我们介绍了 Java 的文件字节流框架中的相关内容,而我们本篇文章将着重于文件字符流的相关内容. 首先需要明确一点的是,字节流处理文件的时候是基于字节的,而字符流处理文件则是基于一个个字符为 ...

  6. Java开源生鲜电商平台-团购模块设计与架构(源码可下载)

    Java开源生鲜电商平台-团购模块设计与架构(源码可下载) 说明:任何一个电商系统中,对于促销这块是必不可少的,毕竟这块是最吸引用户的,用户也是最爱的模块之一,理由很简单,便宜. 我的经验是无论是大的 ...

  7. RabbitMQ和Kafka到底怎么选(二)?

    前言 前一篇文章<RabbitMQ和Kafka到底怎么选?>,我们在吞吐量方面比较了Kafka和RabbitMQ,知道了Kafka的吞吐量要高于RabbitMQ.本文从可靠性方面继续探讨两 ...

  8. ASP.NET Core 实战:使用 Docker 容器化部署 ASP.NET Core + MySQL + Nginx

    一.前言 在之前的文章(ASP.NET Core 实战:Linux 小白的 .NET Core 部署之路)中,我介绍了如何在 Linux 环境中安装 .NET Core SDK / .NET Core ...

  9. Mybatis之旅第五篇-动态SQL

    一.引言 在之前的CRUD例子中,都是一些很简单的SQL,然而实际的业务开发中会有一些复杂的SQL,我们经常需要拼接SQL,拼接的时候要确保不能忘了必要的空格,还要注意省掉列名列表最后的逗号.Myba ...

  10. HTTP/2 简介

    支撑现有 Web 服务的 HTTP 协议距离其发布时的 1997 年已经有些年月了,随后的 HTTP/1.1 版本发布自 1999 年.随着技术的进步和需求的进化,对于数据快速高效地传输,HTTP/1 ...