vimwiki与markdown语法速查

date: 2013.06.03; modification:2016.05.10

目录:

1 标题

<tr>
    <td> 级别 </td>
    <td> Vimwiki </td>
    <td> Markdown </td>
    <td> 效果 </td>
</tr>
<tr>
    <td> 一级 </td>
    <td> =一级标题= </td>
    <td> #一级标题 </td>
    <td><h1> 一级标题 </h1></td>
</tr>
<tr>
    <td> 二级 </td>
    <td> ==二级标题== </td>
    <td> ##二级标题 </td>
    <td><h2> 二级标题 </h2></td>
</tr>
<tr>
    <td> 三级 </td>
    <td> ===三级标题=== </td>
    <td> ###三级标题 </td>
    <td><h3> 三级标题 </h3></td>
</tr>
<tr>
    <td> 四级 </td>
    <td> ====四级标题==== </td>
    <td> ####四级标题 </td>
    <td><h4> 四级标题 </h4></td>
</tr>
<tr>
    <td> 五级 </td>
    <td> =====五级标题===== </td>
    <td> #####五级标题 </td>
    <td><h5> 五级标题 </h5></td>
</tr>
<tr>
    <td> 六级 </td>
    <td> ======六级标题====== </td>
    <td> ######六级标题 </td>
    <td><h6> 六级标题 </h6></td>
</tr>

2 文字格式

说明: 下表中的"标记"这一列中应该没有空格, 加上只是为了不被转换, 而不是有效字符

Vimwiki Markdown 效果
*bold* **bold** bold
_italic_ _italic_ italic
`code` `code` code

3 代码高亮

python:

class TestHelloWorld(object):
  """Hello world python."""
  def __init__(self, name):
    self.name = name

  def say(self):
    print("hello {0}".format(self.name))

js:
function helloSyntaxHighlighter()
{
    return "hi!";
}
c:
#define HELLO 1
#if HELLO
int hello;
helloSyntaxHighlighter()
{
    return "hi!";
}
#endif

4 列表

4.1 无序列表

语法:

* bullet item 1
    * sub item 1
        * sub sub item 1

效果:

4.2 有序列表

语法:

1. numbered list item A
    1. sub numbered list item a
1. numbered list item C

效果:

  1. numbered list item A
    1. sub numbered list item a
  2. numbered list item C

5 表格

5.1 简单表格

markdown本身并不支持表格, 此处的表格语法是pandoc扩展的. 如前文中的表格, 需要如下写法:

----------------------------------------------------------
Vimwiki            空       Markdown              效果
------------       列    -------------------   ----------- 这里间断线表示表头
\*bold\*           表    \**bold**             **bold**    表格项必须在间断线
                   示                                      的覆盖下
\_italic_          列    \_italic_             _italic_
                   分    空行表示行行分割
\`code`            割    \`code`               `code`

----------------------------------------------------------

效果:

Vimwiki Markdown 效果
*bold* **bold** bold
_italic_ _italic_ italic
`code` `code` code

上面这种表格在处理中文的时候, 有些pandoc版本有点麻烦. 因为中文是多字节的, 所以有可能会有对齐宽度的问题.

另外一种pandoc表格格式稍微麻烦一些, 但是适合中文:

5.2 适合中文的表格

| 右对齐| 左对齐 |   默认  |  中心  |
|------:|:-------|---------|:------:|
|   12  |  汉字  |    12   |    12  |
|  中文 |  测试  |   123   |   123  |
|    1  |    1   |   eng   |     1  |

  : Demonstration of pipe table syntax.
这里由于含有中文, 所以浏览器中显示可能不对齐.
在等宽字体软件中, 这里的每列竖线是对齐的.

效果如下:

Demonstration of pipe table syntax.
右对齐 左对齐 默认 中心
12 汉字 12 12
中文 测试 123 123
1 1 eng 1

5.3 适合多行的表格

: Sample grid table.

+---------------+---------------+--------------------+
| Fruit         | Price         | Advantages         |
+===============+===============+====================+
| *Bananas*     | $1.34         | - built-in wrapper |
|               |               | - bright color     |
+---------------+---------------+--------------------+
| **Oranges**   | $2.10         | * cures scurvy     |
|               |               | * tasty            |
+---------------+---------------+--------------------+

效果:

Sample grid table.
Fruit Price Advantages

Bananas

$1.34

  • built-in wrapper
  • bright color

Oranges

$2.10

  • cures scurvy
  • tasty

据说这种表格不支持对齐的标记, 我试了, 至少我的版本确实是不支持. 不知道为什么pandoc不增加这种支持.

当然, 也可以借用html的table标签来绘制表格, 那样就支持原生的markdown了, 而不是仅仅pandoc支持.

6 链接

6.1 页面链接

语法:

[首页](../../../index.html)

效果:

首页

6.2 图片链接

语法:

![mpeg2_encoder](../../dtv/codec/mpeg2_encoder.jpg)

效果:

mpeg2_encoder

mpeg2_encoder