reStructuredText,我使用的子集

基础语法

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

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

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

标题

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

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

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

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

行内标记

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

链接

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

代码块

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

图片

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

表格

略, 和 Markdown 的语法一致

几个较难的地方

  • 代码块( 注意其空行,缩进 )
  • 链接
  • 尤其注意某些语法的空行,空格以及缩进, RST 对这些非常敏感, 某些小细节没有写对, 直接渲染不出
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • << [访问 Wow!Ubuntu](http://wowubuntu.com)**NOTE:** This is...
    金木水火土V阅读 3,821评论 0 1
  • 为什么学习Markdown 自从搭建了 Hexo 博客之后,发现还有 Markdown 这种写文章的方法,想到以后...
    lifeColder阅读 20,304评论 10 216
  • Markdown 语法 之剑 2016.5.3 23:41:46 hljs.initHighlightingOnL...
    光剑书架上的书阅读 5,550评论 1 5
  • 撞壁,撞着撞着可能也就过去了,但一直在安全区的话……
    GratitudeL阅读 1,594评论 0 0
  • 前天初中的同学来济南,招待了一下。每年都能见一面,但之前是很多人一起在一起,所以也一直没机会深入聊一聊,前天算是一...
    于帅Jacob阅读 3,161评论 0 0

友情链接更多精彩内容