前言

Markdown是一种轻量级标记语言，创始人为约翰·格鲁伯（英语：John Gruber）。 它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的XHTML（或者HTML）文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。文档后缀为 .md, .markdown。

Typora 编辑器

下载安装

下载地址
https://typora.io/

安装
更改安装路径>Next>创建桌面快捷方式>Install>Finish

在Typora中，某些文件格式（包括docx，odt，rtf，epub，LaTeX和Wiki）的导入和导出功能由名为Pandoc的第三方软件提供支持。这些功能需要安装Pandoc（≥v1.16）。
请注意，对于Typora，Pandoc的安装是可选的，如果不需要Typora中的高级导入/导出支持，则不必在计算机上安装Pandoc。

使用

打开

可以选择显示/隐藏侧边栏或者源代码模式

导出
可以选择导出PDF、HTML、Word、LaTex等

设置
文件>偏好设置

设置自动防止忘记保存导致写的内容丢失
设置图像的保存路径方便打包
设置Markdown语法以符合自己的习惯

Markdown基础语法

标题

键入“

@[TOC](这里写目录标题)
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

图像

由于Markdown文件是纯文本文件，因此不能直接将图像数据插入Markdown文件中，而是插入对图像文件的引用。
在Markdown中，图像的书写方式为[alt](src)。在src这里可以像一个URL https://octodex.github.com/images/yaktocat.png，或绝对/相对文件路径，像../images/test.png。

Typora支持从剪贴板粘贴图像数据。Typora会将图像数据放入给定的文件夹或服务器，然后插入引用该存储文件或URL的图像

允许您使用<img>标签显示图像，也可以用于调整图像的大小
例如：<img src="https://www.google.com/doodles/kamma-rahbeks-241st-birthday" width="200px" />

链接

超链接

[Link Text](link-address)

[Link Text](link-address "optional title")

参考链接

[Link Text][Ref]

[Ref]: link-address "optional title"

自动链接

<http://typora.io>

内部链接

# This is a title
...
...
...

A [link](#this-is-a-title) to jump towards target header

还可以使用HTML<a>标签

列表

无序列表

 - List item

• List item

有序列表

 1. List item

1. List item

待办事项

 - [ ] List item

• [ ] List item

表格

要创建表，只需在markdown中写出表头即可。

|First Header | Second Header|
|--|--|

也可以从菜单栏中插入表格。
一个表必须具有表头以及至少一行和一列。

代码

最新版本的Typora支持以下语言的语法高亮显示(小写):
asp (alias: aspx, asp.net)
javascript (alias: js, text/javascript)
json
typescript
clojure
coffeescript (alias: coffee)
css
less
scss
gfm (github flavored markdown)
markdown
xml
haskell
html (alias: htmlmixed)
lua
commonlisp (alias: lisp)
pascal
perl
php (and php+html)
cython
python
ruby
shell (alias: sh, bash)
sql
mssql
mysql
mariadb
cql (alias: cassandra)
plsql
tex (and stex, latex)
tiddlywiki (alias: wiki)
vb (alias: basic)
vbscript
velocity
verilog
xquery
yaml
go
groovy
nginx
oz
octave (alias: matlab)
c (alias: clike)
c++ (alias: cpp, cc)
objective-c (alias: obj-c, objc)
scala
c# (alias: csharp)
java
squirrel
ceylon
kotlin
swift
r (alias: rlang, r-lang)
d
diff
erlang
http
jade
rst (alias: restructuredtext)
rust
jinja2
jsp
erb
embeddedjs (alias: ejs)
powershell
dockerfile
jsx (alias: react)
vue (alias: vue.js, vue-template)
nsis
tiki (alias: tikiwiki, tiki-wiki)
properties (alias: ini)
livescript
assembly (alias: asm, nasm, gas)
toml
ocaml
F#
elm
elixir
spreadsheet
pgp (alias: asciiarmor, pgp-keys)
cmake
cypher
dart
django
dtd (alias: xml-dtd)
dylan
handlebars
idl
web-idl
yacas
mbox
bhdl
julia
haxe
hxml
fortran
protobuf
makefile
tcl
scheme
twig
SAS
pseudocode
julia
stylus
COBOL

数学公式

Typora支持使用Tex / LaTeX语法渲染普通数学公式。渲染过程由MathJax处理。

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

$$
\Gamma(z) = \int_0^\infty t^{z-1}e{-t}dt,.
$$

数学块是用$$标记和换行符包装的LaTeX表达式
内联数学使用这样的语法\$<Math Expressions>$，例如：$f = \frac{2 \pi}{T}$ 渲染为$f = \frac{2 \pi}{T}$。

绘制图表

当导出为HTML，PDF，epub，docx时，这些渲染图也将包括在内，但是当将markdown导出为当前版本的其他文件格式时，不支持图功能。此外，应该注意，标准Markdown，CommonMark或GFM不支持图表。因此，建议插入这些图的图像，而不是直接将它们写在Markdown中。

顺序图

使用js-sequence

?```mermaid
sequenceDiagram
Alice->>Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->>Alice: I am good thanks!

或者
?```\sequence
Alice->>Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->>Alice: I am good thanks!
?```

流程图

使用flowchart.js

?```mermaid
flowchat
st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes)->e
cond(no)->op
?```

类图

```mermaid
classDiagram
      Animal <|-- Duck
      Animal <|-- Fish
      Animal <|-- Zebra
      Animal : +int age
      Animal : +String gender
      Animal: +isMammal()
      Animal: +mate()
      class Duck{
          +String beakColor
          +swim()
          +quack()
      }
      class Fish{
          -int sizeInFeet
          -canEat()
      }
      class Zebra{
          +bool is_wild
          +run()
      }
```

甘特图

状态图

```mermaid
stateDiagram
    [*] --> Still
    Still --> [*]
    Still --> Moving
    Moving --> [*]
```

饼图

```mermaid
pie
    title Pie Chart
    "Dogs" : 386
    "Cats" : 85
```

内联样式

链接
将链接目标设置为标题、markdown文件或URL

[Jump to Header 1](#header-1)
[Credits.md](Credits.md),
[website]0]
[website]; http://typora.io

加粗

**加粗样式**

斜体

*斜体样式*

删除线

~~删除线格式~~ 

下划线

$\underline{\text{下划线}}$
或者
<u>下划线</u>

代码语法高亮

`代码语法高亮`

文字颜色

<font color=#0099ff>文字颜色</font>

文字

==文字==

其它

Typora中的自定义字体由CSS设置。例如，base.user.css在主题文件夹下附加以下内容

body {
  font-family: Courier;
}

其它技巧

转义

Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符：

**文本加粗** 
\*\* 正常显示星号 \*\*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

快捷键

Typora快捷键

File

Edit

Paragraph

Format

View

更改快捷键

文件>偏好设置>通用>自定义快捷键

用户可以在Typora的菜单栏中设置或重新分配命令的快捷键

打开并编辑conf.user.json ，如果没有这样的文件，创建一个

设置或添加表示键绑定的JSON对象

重新启动Typora，将应用新的快捷键绑定。

HTML

Markdown支持的 HTML 元素，不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。

CSS

Typora将按照以下顺序加载CSS文件:

1. Typora’s basic styles
2. CSS for current theme
3. base.user.css under theme folder
4. {current-theme}.user.css under theme folder.

参考文档

typora文档

https://mermaid-js.github.io/mermaid/#/

http://www.markdown.cn/

https://daringfireball.net/projects/markdown/

Markdown 书写风格指南

Markdown总结

原文：https://www.cnblogs.com/patrick-HL/p/14699369.html