Markdown 学习笔记

Markdown 学习笔记

标签: Markdown


目录


前言

最近刚刚开始写博客,之前从朋友那里简单了解过Markdown,他给我演示了加粗与标题等特性,第一感觉是它很适合书写Readme等简单的文档。开了博客之后发现Markdown也可以作为博客书写的主要方式,这勾起了我的兴趣。在某搜索引擎上简单了解了一下,一发不可收拾。Markdown这种语言很适合用于书写设计文档、工作计划、读书笔记,除“所见即所得”的排版之外,还能绘制流程图、表格、甘特图、时序图等等。语法非常简单,容易上手,漂亮简洁的排版令人赏心悦目。使用Markdown书写文档,可以使得我将更多的注意力放在文档的内容,而非格式上。下面将使用Markdown记录我的学习成果。

书写本文档时使用的是作业部落出品的Cmd Markdown编辑器,该编辑器支持书写的同时对内容进行实时预览,非常方便,有在线和离线版本。它的帮助文档亦使用Markdown书写,非常适合初学者上手。本文中的大量示例摘抄自该文档,并作出了一定的修改以适应博客排版。


什么是Markdown


基本语法

1. 斜体和粗体

  • 斜体: 使用*文字*来表示
  • 粗体: 使用**文字**来表示[1]
  • 删除: 使用~~ 文字 ~~来表示 (文字前后没有空格)

2. 分级标题

使用 === 表示一级标题,使用 --- 表示二级标题[2]

示例:

这是一个一级标题(= 数目 > 0)
================

这是一个二级标题(- 数目 > 0)
----------------

你也可以选择在行首加“相应数目的井号[3]”表示不同级别的标题 (H1-H6)。

示例:

#    一级标题
##   二级标题
###  三级标题
#### 四级标题
...

3. 外链接

使用 [描述](链接地址) 为文字增加外链接,也可以使用无描述的链接地址(也可用<>将其封闭)。

示例:

这是去往 [本人博客](http://www.cnblogs.com/axecalibur/) 的链接。
http://www.cnblogs.com/axecalibur/
<http://www.cnblogs.com/axecalibur/>

效果:

这是去往 本人博客 的链接。
http://www.cnblogs.com/axecalibur/
http://www.cnblogs.com/axecalibur/

4. 无序列表

使用 *,+,- 表示无序列表[4],支持缩进。

示例:

* 无序列表项 一
+ 无序列表项 二
- 无序列表项 三
    * 二级缩进
        + 三级缩进
            - 四级缩进

效果:

  • 无序列表项 一
  • 无序列表项 二
  • 无序列表项 三
    • 二级缩进
      • 三级缩进
        • 四级缩进

5. 有序列表

使用数字和点表示有序列表[5]

示例:

1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三

效果:

  1. 有序列表项 一
  2. 有序列表项 二
  3. 有序列表项 三

6. 定义型列表

示例:

Markdown
: 轻量级文本标记语言,可以转换成html,pdf等格式

Apple
: 一种水果

效果:

Markdown
轻量级文本标记语言,可以转换成html,pdf等格式
Apple
一种水果

7. 文字引用

使用 > 表示文字引用[6],支持嵌套。上文中大量使用了文字引用来表示【效果】部分。

示例:

> 离离原上草,一岁一枯荣。
>> 野火烧不尽,春风吹又生。
>
> 远芳侵古道,晴翠接荒城。
>> 又送王孙去,萋萋满别情。

效果:

离离原上草,一岁一枯荣。

野火烧不尽,春风吹又生。

远芳侵古道,晴翠接荒城。

又送王孙去,萋萋满别情。

8. 行内代码块

使用 `代码` 表示行内代码块。

示例:

让我们聊聊 `html`。

效果:

让我们聊聊 html

9. 代码块

使用 四个缩进空格 表示代码块。

示例:

    这是一个代码块,此行左侧有四个不可见的空格。

效果:

这是一个代码块,此行左侧有四个不可见的空格。

也可以用三个`将代码段从上下包住,上述示例中就是这样做的,这使得markdown的语法被忽略。

10. 图片


参考资料

Markdown 语法说明 (简体中文版)
一个更详尽的语法说明,里面有一些Markdown的基础知识
Markdown: Basics (快速入门)
与本文类似的快速入门指南
认识与入门 Markdown
来自:少数派
用markdown来画流程图
来自简书:Jlan
Markdown时序图
来自简书:专业打码高科技

  1. 在斜体和粗体中,星号也可以用下划线来代替 ↩︎

  2. 分级标题:=号和-号的数目大于零即可,无硬性数目限制,所以可以多写一些美化源文件。 ↩︎

  3. 分级标题:#号最多为6个(H6),后面跟随的空格数没有限制,可以为0 ↩︎

  4. 无序列表:+,-,*符号可以混用,Markdown语法并不关心。为保持原始文本美观,应该尽量书写一致。 ↩︎

  5. 有序列表:点号后面必须有空格。比较有趣的是,这里数字可以是无序的,当然我们为了保证源文件的可读性不应该这样做。 ↩︎

  6. 文字引用:>符号后可以没有空格。 ↩︎

posted @ 2018-02-22 21:57  axecalibur  阅读(172)  评论(0)    收藏  举报