Forgot your password?
Document Actions
reStructuredText是个好东西
Submitted by
livahu.
on 2007-10-26 19:54.
学习reStructuredText笔记
首先我觉得用 reStructuredText 写文档是 所想即所得 的
所见即所得偏重的是外观设计，而不是代码，将开发者从代码中解救出来，使其专注于设计；
而所想即所得工具不需要设计外观，把设计者从外观中解救出来，使其专注行思考！
这就是 reStructuredText 的思想!
首先说下 reStructuredText 中的元素分类：
- 基本元素
- 字串元素: 连续的字符串构成的元素，以空格分隔。
- 行元素: 下划线（有时包括上划线）和文本构成的元素。
- 块元素: 具有相同缩进的元素为块元素，以一个空行分隔。
- 特殊元素
- 页面元素: 类似行元素，但是不包含缩进，例如：标题、分隔线。
- 超级块元素: 类似块元素，但是可以包含空行，并且内部可以随意缩进。例如：注释、块引用。
- 注释: 注释是以 .. 起始的超级块元素，注释中的内容只在源文件中显示，并不在结果中显示。 引导符 .. 前不能有其它字符，之后要有一个空格与注释内容分隔开（ .. 同时是一个字串元素，前后都要有分隔符）。
- 块引用：块引用是以 :: 起始的超级块元素，块引用的内容不作任何处理，以原文显示，引导符 :: 后必须有一个空行。
- 物件元素：用来定义一个物件，物件元素由行内字串元素或注释中的块元素构成 以 _ 结尾的字串元素，例如：链接_ [脚注]_ ，以 | 包裹的字串元素，例如 |别名| 我的老博客
在 reStructuredText 中， ** 表示特别强调， * 表示强调（采用斜体字样）， `` 表示引用
| 输入内容 | 展现结果 |
| *斜体* | 斜体 |
| **特别强调** | 特别强调 |
| ``*引用部分*`` | *引用部分* |
| \*原文* | *原文* |
注意: 只要没有空行，不管换多少次行，都会处理为一行。
章节层次结构：
第一级 ============== 第二级 -------------- 第三级 `````````````` 第四级 '''''''''''''' 第五级 """""""""""""" ---------------过渡线
实际效果：