Markdown 教程

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown 编写的文档后缀为 .md, .markdown


Markdown 应用

Markdown 能被使用来撰写电子书,如:Gitbook。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。


编辑器

常用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


Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。

支持导出HTML、PDF、Word、图片等多种类型文件。

Typora 官网:https://typora.io/

在线编辑器来测试: markdown-editor-online


测试实例

Mardown 编写 Hello World! 语法:
# Hello World!


常用语法

Markdown格式选项和键盘快捷键
输出后的效果Markdown快捷键
Bold**text**Ctrl/⌘ + B
Emphasize*text*Ctrl/⌘ + I
Link[title](http://)Ctrl/⌘ + K
Inline Code`code`Ctrl/⌘ + Shift + K
Image![alt](http://)Ctrl/⌘ + Shift + I
List* itemCtrl + L
Blockquote> quoteCtrl + Q
H1# Heading
H2## HeadingCtrl/⌘ + H
H3### HeadingCtrl/⌘ + 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) :--------
  • 方框:- [ ] -