很多时候我们并不需要撰写.doc或者.pdf格式文档, 用简单清晰的语法写一篇markdown格式的文档就够了, 它可读性高,方便撰写,而且能够轻易的生成格式优美的html文件, 所以,为什么不用markdown呢。

更多关于markdown的信息

下面是一些markdown的基本用法:

标题

在文字前加# 使其变为标题, # 相当于html中的h1, ## 相当于html中的h2, 以此类推

# 大标题
## 中标题
### 小标题
#### 小小标题

大标题

中标题

小标题

小小标题

链接

使用< >尖括号包裹需要被点击的链接

<https://cheng10.cc/articles/>

https://cheng10.cc/articles/

尖括号同样可以作用于邮件地址链接

<cheng10@ualberta.ca>

cheng10@ualberta.ca

文字链接

使用[文字](链接)格式编写文字链接, 中括号内为链接的展示问题,圆括号内为链接的地址

[我的博客](https://cheng10.cc)

我的博客

嵌入图片

图片也是一种特殊的链接, 中括号内的内容即为html中的图片alt

![my-avatar](/articles/assets/my_avatar.jpg)

my-avatar

引用链接

也可以以这种方式使用链接,格式类似论文的引用

I use [Google][1] more than [Yahoo][2] or [Bing][3].

[1]: http://google.com/ "Google Search"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://www.bing.com/ "Bing Search"

I use Google more than Yahoo or Bing.

加粗字体,斜体

使用* *星号包裹需要被变为斜体的文字 使用** **两个星号包裹需要被加粗的文字 使用*** ***三个星号加粗并且变为斜体 可以使用下划线代替星号

*hello world*

**hello world**

***hello world***

_hello world_

__hello world__

___hello world___

hello world

hello world

hello world

hello world

hello world

hello world

列表

用加号,减号或者星号表示无序列表

+ 红肉
+ 白肉
+ 蔬菜
+ 水果
    + 苹果
        + 红富士
        + 国光
    + 梨子
    + 香蕉

+ 你可以用加号
- 也可以用减号
* 也可以用星号
  • 红肉
  • 白肉
  • 蔬菜
  • 水果
    • 苹果
      • 红富士
      • 国光
    • 梨子
    • 香蕉
  • 你可以用加号
  • 也可以用减号
  • 也可以用星号

1. 表示有序列表

1. 刷牙
2. 吃早饭
    1. 买包子
    2. 吃包子
3. 出门
    + 带手机
    + 带钥匙
3. 数字并不需要真的准确
3. 只要是数字就可以
3. 序号仍然是对的
  1. 刷牙
  2. 吃早饭
    1. 买包子
    2. 吃包子
  3. 出门
    • 带手机
    • 带钥匙
  4. 数字并不需要真的准确
  5. 只要是数字就可以
  6. 序号仍然是对的

引用

块引用

使用> 来引用一段文字

> 春江潮水连海平,海上明月共潮生。
> 滟滟随波千万里,何处春江无月明!
> ...

春江潮水连海平,海上明月共潮生。 滟滟随波千万里,何处春江无月明! …

行内引用

使用back-tick(反勾号,键盘上esc键下方)包裹需要被引用的内容

你好`code`世界

你好code世界

代码引用

使用```包裹一段代码来引用他们,并且支持语法高亮


```python
s = "Python syntax highlighting"
print s
```
s = "Python syntax highlighting"
print s

横线

使用三个以上星号,连字符或者下划线来表示一条横线

***
---
___



换行

输入一行后,回车一次,下一行仍在同一段落; 回车两次,下一行重新开始一个段落。 也就是说,要想要另起一个段落,需要和上一行之间空一行。

第一行
第二行

新的段落

第一行 第二行

新的段落

内嵌HTML

在markdown文件中,也可以直接使用html语句

<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.

表格

使用冒号来对齐表格的列(左对齐,右对齐,居中)

| 名称   | 数量   | 单价  |
| ------ |:------:| -----:|
| 苹果   | 12     | $1600 |
| 梨子   | 8      |   $12 |
| 香蕉   | 23     |    $1 |

至少需要三个连字符来分割表格的头部;
最外层的`|`不是必须的;
你不必仔细对齐字符, 下面的排列也可以表示表格

Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3

使用冒号来对齐表格的列(左对齐,右对齐,居中)

名称 数量 单价
苹果 12 $1600
梨子 8 $12
香蕉 23 $1

至少需要三个连字符来分割表格的头部; 最外层的|不是必须的; 你不必仔细对齐字符, 下面的排列也可以表示表格

Markdown Less Pretty
Still renders nicely
1 2 3

License: CC-BY

Reference:

  1. Markdown-Cheatsheet
  2. Markdown: Syntax