Markdown工具使用技巧


由 Aaron Swartz 和 John Gruber 共同设计 => 天才都有早逝的归途

Markdown  是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用。看到这里请不要被「标记」、「语言」所迷惑,Markdown 的语法十分简单。

常用的标记符号也不超过十个,这种相对于更为复杂的 HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永逸的效果。

Markdown工具使用技巧


1. 标题

  • 语法格式
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题
  • 展示效果

Markdown工具使用技巧


2. 列表

  • 语法格式
# 无序列表
-   Red
-   Green
-   Blue

# 有序列表
1.  Bird
2.  McHale
3.  Parish
  • 展示效果

Markdown工具使用技巧


3. 引用

  • 语法格式
> ## 这是一个标题。
>
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
>
> 给出一些例子代码:
>
>     return shell_exec("echo $input | $markdown_script");
  • 展示效果

Markdown工具使用技巧


4. 链接

  • 语法格式
[an example](http://example.com/)
[an example](http://example.com/ "Optional Title")
  • 展示效果

Markdown工具使用技巧


5. 图片

  • 语法格式
![Alt text](https://avatars0.githubusercontent.com/u/2612642?s=400&u=6635523c237a4f85cbe635b28fbccd014941b675&v=4)
![Alt text](https://avatars2.githubusercontent.com/u/16423215?s=400&u=20c3dfabd125875276b6015f24a97b5954c8c853&v=4 "Optional Title")
  • 展示效果

Markdown工具使用技巧


6. 粗体/斜体

  • 语法格式
*这是斜体*
_这也是斜体_
**这是粗体**
***这是粗体+斜体***
  • 展示效果

Markdown工具使用技巧


7. 删除线

  • 语法格式
就像这样 ~~就像这样~~ 就像这样
就像这样 ~~就像这样~~ 就像这样
就像这样 ~~就像这样~~ 就像这样
  • 展示效果

Markdown工具使用技巧


8. 表格

  • 语法格式
| Item      |    Value | Qty  |
| :-------- | --------:| :--: |
| Computer  | 1600 USD |  5   |
| Phone     |   12 USD |  12  |
| Pipe      |    1 USD | 234  |
  • 展示效果

Markdown工具使用技巧


9. 代码块

  • 语法格式
@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
class SomeClass:
    pass

>>> message = '''interpreter
... prompt'''
  • 展示效果

Markdown工具使用技巧


10. 分割线

  • 语法格式
* * *
***
*****
- - -
---------------------------------------
  • 展示效果

Markdown工具使用技巧


11. 公式

  • 语法格式
$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$
  • 展示效果

Markdown工具使用技巧


12. 流程图

  • 语法格式
st=>start: Start
e=>end
op=>operation: My Operation
cond=>condition: Yes or No?

st->op->cond
cond(yes)->e
cond(no)->op
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
  • 展示效果

Markdown工具使用技巧


13. 复选框

  • 语法格式
使用 `- [ ]``- [x]` 语法可以创建复选框,实现 todo-list 等功能。例如:
- [x] 已完成事项
- [-] 待办事项1
- [-] 待办事项2
  • 展示效果

Markdown工具使用技巧


14. 内容对比

  • 语法格式
function addTwoNumbers (num1, num2) {
-  return 1 + 2
+  return num1 + num2
}
  • 展示效果

Markdown工具使用技巧


15. 特殊字符

  • 使用事项

特殊字符自动转义

  • 语法格式
©
<
&
AT&T
  • 展示效果

Markdown工具使用技巧


16. 转义

  • 使用事项

Markdown 支持在以下字符前面插入反斜杠,插入之后,将不再解析这些字符,而是原样输出。

  • 语法格式
\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

文章作者: Escape
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 Escape !
  目录