Markdown的语法简洁明-白红宇

Markdown的语法简洁明

阅读量：4185 次

发布时间：2019-05-26

本文共 2428 字，大约阅读时间需要 8 分钟。

GitBook[1] 是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 来制作精美的电子书，GitBook 并非关于 Git 的教程。

GitBook支持输出多种文档格式：

·静态站点：GitBook默认输出该种格式，生成的静态站点可直接托管搭载Github Pages服务上；

·PDF：需要安装gitbook-pdf依赖；

·eBook：需要安装ebook-convert；

· 单HTML网页：支持将内容输出为单页的HTML，不过一般用在将电子书格式转换为PDF或eBook的中间过程；

·JSON：一般用于电子书的调试或元数据提取。

使用GitBook制作电子书，必备两个文件：README.md和SUMMARY.md[2] 。

Markdown的语法简洁明了、学习容易，而且功能比纯文本更强，因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。

用于编写说明文档，并且以“README.MD”的文件名保存在软件的目录下面。

Markdown 指南

编辑

常用语法

最常见的Markdown格式选项和键盘快捷键[2] :

输出后的效果

Markdown

快捷键

Bold **text** Ctrl/⌘ + B

Emphasize *text* Ctrl/⌘ + I

Strike-through ~~text~~ Ctrl + Alt + U

Link [title](http://) Ctrl/⌘ + K

Inline Code `code` Ctrl/⌘ + Shift + K

Image ![alt](http://) Ctrl/⌘ + Shift + I

List * item Ctrl + L

Blockquote > quote Ctrl + Q

H1 # Heading

H2 ## Heading Ctrl/⌘ + H

H3 ### Heading Ctrl/⌘ + H (x2)

标题

标题能显示出文章的结构。行首插入1-6个 # ，每增加一个 # 表示更深入层次的内容，对应到标题的深度由 1-6 阶。

●

H1 :# Header 1

●

H2 :## Header 2

●

H3 :### Header 3

●

H4 :#### Header 4

●

H5 :##### Header 5

●

H6 :###### Header 6

文本样式

●

链接 :[Title](URL)

●

加粗 :**Bold**

●

斜体字 :*Italics*

●

删除线 :~~text~~

●

高亮 :==text==

●

段落 : 段落之间空一行

●

换行符 : 一行结束时输入两个空格

●

列表 :* 添加星号成为一个新的列表项。

●

引用 :> 引用内容

●

内嵌代码 : `alert('Hello World');`

●

画水平线 (HR) :--------

图片

使用Markdown将图像插入文章，你需要在Markdown编辑器输入 ![]() 。这时在预览面板中会自动创建一个图像上传框。你可以从电脑桌面拖放图片(.png, .gif, .jpg)到上传框, 或者点击图片上传框使用标准的图像上传方式。如果你想通过链接插入网络上已经存在的图片，只要单击图片上传框的左下角的“链接”图标，这时就会呈现图像URL的输入框。想给图片添加一个标题, 你需要做的是将标题文本插图中的方括号，e.g;![This is a title]().

脚注

使用这样的占位符号可以将脚注添加到文本中:[^1]. 另外，你可以使用“n”而不是数字的[^n]所以你可以不必担心使用哪个号码。在您的文章的结尾，你可以如下图所示定义匹配的注脚，URL将变成链接:

[^1]: This is my first footnote

[^n]: Visit http://example.com

[^n]: A final footnote

写代码

添加内嵌代码可以使用一对回勾号 `alert('Hello World')`.对于插入代码, Ghost支持标准的Markdown代码和GitHub Flavored Markdown (GFM)[3] 。标准Markdown基于缩进代码行或者4个空格位:

<h1>{

{title}}</h1>

</header>

GFM 使用三个回勾号```