什么是 Markdown
Markdown 是一种方便记忆、书写的纯文本标记语言,用户可以使用这些标记符号以最小的输入代价生成极富表现力的文档:如您正在阅读的这篇文章。它使用简单的符号标记不同的标题,分割不同的段落,粗体 或者 斜体 某些文字.
很多产品的文档也是用markdown编写的,并且以“README.MD”的文件名保存在软件的目录下面。
一些基本语法
标题
H1 :# Header 1
H2 :## Header 2
H3 :### Header 3
H4 :#### Header 4
H5 :##### Header 5
H6 :###### Header 6
链接 :Title
加粗 :Bold
斜体字 :Italics
删除线 :text
段落 : 段落之间空一行
换行符 : 一行结束时输入两个空格
列表 : 添加星号成为一个新的列表项。
引用 :> 引用内容
内嵌代码 : alert('Hello World');
画水平线 (HR) :——–
css 的大部分语法同样可以在 markdown 上使用,但不同的渲染器渲染出来的 markdown 内容样式也不一样,下面这些链接里面有 markdown 基本语法,你也可以在下面几个平台上尝试着写一些。
格式整理
Markdown是一种轻量级的「标记语言」
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面,Markdown文件的后缀名便是“.md”
MdEditor是一个在线编辑Markdown文档的编辑器
MdEditor扩展了Markdown的功能(如表格、脚注、内嵌HTML等等),以使让Markdown转换成更多的格式,和更丰富的展示效果,这些功能原初的Markdown尚不具备。
Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如
Pandoc,Pandao;要么基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。
MdEditor源于Pandao的JavaScript开源项目,开源地址Editor.md,并在MIT开源协议的许可范围内进行了优化,以适应广大用户群体的需求。向优秀的markdown开源编辑器原作者Pandao致敬。
MdEditor的功能列表演示
标题H1
标题H2
标题H3
标题H4
标题H5
标题H5
字符效果和横线等
删除线 删除线(开启识别HTML标签时)
斜体字 斜体字
粗体 粗体
粗斜体 粗斜体
上标:X2,下标:O2
缩写(同HTML的abbr标签)
即更长的单词或短语的缩写形式,前提是开启识别HTML标签时,已默认开启
The HTML specification is maintained by the W3C.
引用 Blockquotes
引用文本 Blockquotes
引用的行内混合 Blockquotes
引用:如果想要插入空白换行
即<br />标签
,在插入处先键入两个以上的空格然后回车即可,普通链接。
锚点与链接 Links
普通链接 普通链接带标题 直接链接:https://www.mdeditor.com [锚点链接][anchor-id] [anchor-id]: https://www.mdeditor.com/ mailto:test.test@gmail.com GFM a-tail link @pandao 邮箱地址自动链接 test.test@gmail.com www@vip.qq.com
@pandao
多语言代码高亮 Codes
行内代码 Inline code
执行命令:npm install marked
缩进风格
即缩进四个空格,也做为实现类似 <pre>
预格式化文本 ( Preformatted Text ) 的功能。
<?php
echo "Hello world!";
?> 预格式化文本:
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
JS代码
function test() {
console.log("Hello world!");
}
HTML 代码 HTML codes
<!DOCTYPE html>
<html>
<head>
<mate charest="utf-8" />
<meta name="keywords" content="Editor.md, Markdown, Editor" />
<title>Hello world!</title>
<style type="text/css">
body{font-size:14px;color:#444;font-family: "Microsoft Yahei", Tahoma, "Hiragino Sans GB", Arial;background:#fff;}
ul{list-style: none;}
img{border:none;vertical-align: middle;}
</style>
</head>
<body>
<h1 class="text-xxl">Hello world!</h1>
<p class="text-green">Plain text</p>
</body>
</html>
图片 Images
图片加链接 (Image + Link):
Follow your heart.
列表 Lists
无序列表(减号)Unordered Lists (-)
- 列表一
- 列表二
- 列表三
无序列表(星号)Unordered Lists (*)
- 列表一
- 列表二
- 列表三
无序列表(加号和嵌套)Unordered Lists (+)
- 列表一
- 列表二
- 列表二-1
- 列表二-2
- 列表二-3
- 列表三
- 列表一
- 列表二
- 列表三
有序列表 Ordered Lists (-)
- 第一行
- 第二行
- 第三行
GFM task list
- GFM task list 1
- GFM task list 2
- GFM task list 3
- GFM task list 3-1
- GFM task list 3-2
- GFM task list 3-3
- GFM task list 4
- GFM task list 4-1
- GFM task list 4-2
绘制表格 Tables
项目 | 价格 | 数量 |
---|---|---|
计算机 | $1600 | 5 |
手机 | $12 | 12 |
管线 | $1 | 234 |
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
Function name | Description |
---|---|
help() |
Display the help window. |
destroy() |
Destroy your computer! |
Left-Aligned | Center Aligned | Right Aligned |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
Item | Value |
---|---|
Computer | $1600 |
Phone | $12 |
Pipe | $1 |
特殊符号 HTML Entities Codes
© & ¨ ™ ¡ £ & < > ¥ € ® ± ¶ § ¦ ¯ « ·
X² Y³ ¾ ¼ × ÷ »
18ºC " '
[========]
Emoji表情 :smiley:
Blockquotes :star:
GFM task lists & Emoji & fontAwesome icon emoji & editormd logo emoji :editormd-logo-5x:
- :smiley: @mentions, :smiley: #refs, links, formatting, and
tagssupported :editormd-logo:; - list syntax required (any unordered or ordered list supported) :editormd-logo-3x:;
- [ ] :smiley: this is a complete item :smiley:;
- []this is an incomplete item test link :fa-star: @pandao;
- [ ]this is an incomplete item :fa-star: :fa-gear:;
反斜杠 Escape
*literal asterisks*
[========]
科学公式 TeX(KaTeX)
行内的公式行内的公式,行内的公式。
多行公式:
\displaystyle
\left( \sum\_{k=1}^n a\_k b\_k \right)^2
\leq
\left( \sum\_{k=1}^n a\_k^2 \right)
\left( \sum\_{k=1}^n b\_k^2 \right)
\displaystyle
\frac{1}{
\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{
\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {
1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}}
{1+\cdots} }
}
}
f(x) = \int_{-\infty}^\infty
\hat f(\xi)\,e^{2 \pi i \xi x}
\,d\xi
分页符 Page break
Print Test: Ctrl + P
[========]
绘制流程图 Flowchart
st=>start: 用户登陆
op=>operation: 登陆操作
cond=>condition: 登陆成功 Yes or No?
e=>end: 进入后台
st->op->cond
cond(yes)->e
cond(no)->op
[========]
绘制序列图 Sequence Diagram
Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!
End
一些好用的 Markdown 编辑器
MaHua 在线 Markdown 编辑器 ,无须测试。
Markdown Plus 一款 Markdown 编辑器,可以支持添加任务列表、emoji、流程图等。
Cmd Markdown 作业部落在线 Markdown 编辑器推出桌面版客户端啦,全平台支援。
Macdown Github 上开源的 Mac 平台上的 Markdown 编辑器
GitBook Editor 一款团队在线编辑文档工具。可以轻松书写笔记,支持团队协同编辑。同时支持 Markdown 语法,还保持了印象笔记的风格并可在线预览。
Outlinely 界面简洁大方的大纲类 Mac 软件,使用起来很简单,而且支持输出 Markdown 格式。
Classeur 实用简洁的 Markdown 写作工具,快速上手。
DeerResume 程序员专用 MarkDown 简历制作在线工具。
转载请注明:潘柏信的博客 » Markdown工具集