reStructuredText是个好东西

 首先我觉得用 re Structured Text 写文档是 所想即所得

所见即所得偏重的是外观设计,而不是代码,将开发者从代码中解救出来,使其专注于设计;

而所想即所得工具不需要设计外观,把设计者从外观中解救出来,使其专注行思考!

这就是 reStructuredText 的思想!

首先说下 reStructuredText 中的元素分类:

  1. 基本元素
    • 字串元素: 连续的字符串构成的元素,以空格分隔。
    • 行元素: 下划线(有时包括上划线)和文本构成的元素。
    • 块元素: 具有相同缩进的元素为块元素,以一个空行分隔。
  2. 特殊元素
    • 页面元素: 类似行元素,但是不包含缩进,例如:标题、分隔线。
    • 超级块元素: 类似块元素,但是可以包含空行,并且内部可以随意缩进。例如:注释、块引用。
      • 注释: 注释是以 .. 起始的超级块元素,注释中的内容只在源文件中显示,并不在结果中显示。引导符 .. 前不能有其它字符,之后要有一个空格与注释内容分隔开( .. 同时是一个字串元素,前后都要有分隔符)。
      • 块引用:块引用是以 :: 起始的超级块元素,块引用的内容不作任何处理,以原文显示,引导符 :: 后必须有一个空行。
    • 物件元素:用来定义一个物件,物件元素由行内字串元素或注释中的块元素构成以 _ 结尾的字串元素,例如:链接_ [脚注]_ ,以 | 包裹的字串元素,例如 |别名| 我的老博客

reStructuredText 中, ** 表示特别强调, * 表示强调(采用斜体字样), `` 表示引用

输入内容展现结果
*斜体*斜体
**特别强调**特别强调
``*引用部分*``*引用部分*
/*原文**原文*

注意: 只要没有空行,不管换多少次行,都会处理为一行。

章节层次结构:

 第一级
 ==============
 第二级
 --------------
 第三级
 ``````````````
 第四级
 ''''''''''''''
 第五级
 """"""""""""""

---------------过渡线

实际效果:

第一级别

文章序言

第二级别

章正文

第三级别

小节正文

第四级别.1

分论题正文

第五级别.a

细论正文

第五级别.b

细论正文

第四级别.2

分论题正文

章节标题

就是在 行装饰字串 上面一行的文字

过渡

这是个表示过渡的横线


注意,过渡的横线不能为文档的最后元素

上标下标可以这样生成:

这是上标:  :sup:`上标`
这是下标:  :sub:`下标`

注意是两个冒号 :sup: :sub:

实际效果:

这是上标: 上标

这是下标: 下标

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值