Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式,例如LaTeX,Docbook。Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要幺基于工具,如Pandoc;要幺基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。
基本介绍
- 外文名:Markdown
- 套用:文档快速排版
- 格式:LaTeX,Docbook
- 宗旨:易读易写
- 特点:轻量、简单、通用
- 开发者:John Gruber
- 档案后缀名:.md;.markdown;.mdown
用途
Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写部落格。世界上最流行的部落格平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全採用Markdown编辑器的部落格平台有Ghost和Typecho。
用于编写说明文档,并且以“README.md”的档案名称保存在软体的目录下面。
除此之外,由于我们有了RStudio这样的神级编辑器,我们还可以快速将Markdown转化为演讲PPT、Word产品文档、LaTex论文甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown已经广泛使用,极大地推进了动态可重複性研究的历史进程。
使用指南
常用语法
最常见的Markdown格式选项和键盘快捷键:
输出后的效果 | Markdown | 快捷键 |
---|---|---|
Bold | **text** | Ctrl/⌘ + B |
Emphasize | *text* | Ctrl/⌘ + I |
Link | [title](http://) | Ctrl/⌘ + K |
Inline Code | `code` | Ctrl/⌘ + Shift + K |
Image |  | 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
文本样式
(带“*”星号的文本样式,在原版Markdown标準中不存在,但在其大部分衍生标準中被添加)
- 连结 :[Title](URL)
- 加粗 :**Bold**
- 斜体字 :*Italics*
- *高亮 :==text==
- 段落 : 段落之间空一行
- 换行符 : 一行结束时输入两个空格
- 列表 :* 添加星号成为一个新的列表项。
- 引用 :> 引用内容
- 内嵌代码 : `alert('Hello World');`
- 画水平线 (HR) :--------
- 方框:- [ ] -
图片
使用Markdown将图像插入文章,你需要在Markdown编辑器输入 ![]() 。 这时在预览面板中会自动创建一个图像上传框。你可以从电脑桌面拖放图片(.png, .gif, .jpg)到上传框, 或者点击图片上传框使用标準的图像上传方式。 如果你想通过连结插入网路上已经存在的图片,只要单击图片上传框的左下角的“连结”图示,这时就会呈现图像URL的输入框。想给图片添加一个标题, 你需要做的是将标题文本插图中的方括弧,e.g;![This is a title]().
脚注
脚注不存在于标準Markdown中。
使用这样的占位符号可以将脚注添加到文本中:[^1]. 另外,你可以使用“n”而不是数字的[^n]所以你可以不必担心使用哪个号码。在您的文章的结尾,你可以如下图所示定义匹配的注脚,URL将变成连结:
这里是脚注[^1][^1]: 这里是脚注的内容这里是脚注[^n][^n]: 这里是脚注的内容
写代码
添加内嵌代码可以使用一对回勾号 `alert('Hello World')`.对于插入代码, Ghost支持标準的Markdown代码和GitHub Flavored Markdown (GFM)。标準Markdown基于缩进代码行或者4个空格位:
<header> <h1>{{title}}</h1> </header>
GFM 使用三个回勾号```
´´´<header> <h1>{{title}}</h1></header>´´´
例子
连结
This is a paragraph that contains a [link to example]()
列表格式
This paragraph contains a list of items.* Item 1* Item 2* Item three
使用Markdown 引用文本:
This paragraph has a quote> That is pulled out like thisfrom the text my post.
编辑器
常用的Markdown 编辑器
- OSX
VSCode
Atom
Byword
Mou
Typora
MacDown
RStudio
- Linux
VSCode
Atom
Typora
ReText
UberWriter
RStudio - Windows
VSCode
Atom
CuteMarkEd
MarkdownPad2
Miu
Typora
RStudio - iOS
Byword - 浏览器外挂程式
MaDo (Chrome)
Marxico(Chrome) - 高级套用
Sublime Text 3 + MarkdownEditing / 教程