reStructuredText,我使用的子集

基础语法

reStructuredText 是我最喜欢的标记语言, 在 Python 界非常流行(其实是事实标准啦),下面是我自己使用的子集,感兴趣的朋友也可以对照参考之。

我用了一些模板语言里面的语法,方便更加清晰地说明 RST 的语言。

比如 {{content}}, 这样的可直接无视之。

标题

{{head1}}
===========

{{head2}}
-----------------------

{{head3}}
''''''''''''''''''''''''''''''''''''''''''''''

{{head4}}
^^^^^^^^^^^^^^^^^^^^^^

行内标记

`{{content}}`                          斜体
**{{content}}**                      粗体
``{{content}}``                        行内代码块

链接

第一种( 比较简洁, 使用第一种就足够了 )
    `{{链接描述}}  <{{网址}}>`_
第二种( 比较方便 )
    定义:  .. _{{content}}: {{link}}
    使用:  `{{content}}`_

代码块

::
{{1空行}}
{{4缩进}}    {{代码内容}}
{{1空行}}

图片

.. figure:: {{图片链接}}

表格

略, 和 Markdown 的语法一致

几个较难的地方

  • 代码块( 注意其空行,缩进 )
  • 链接
  • 尤其注意某些语法的空行,空格以及缩进, RST 对这些非常敏感, 某些小细节没有写对, 直接渲染不出

你可能感兴趣的:(reStructuredText,我使用的子集)