線上 reStructuredText 編輯器 Online Sphinx Editor reStructuredText Viewer
教學網頁
維基百科 reStructuredText
reStructuredText ( Markup Syntax and Parser Component of Docutils )
副檔名:.rst 開發者:David Goodger
早期的輕量級標記式語言( StructuredText )存在許多問題,reStructuredText 就是為了解決這些問題而開發的,而reStructuredText ( reST )這個名稱就是為了表示 reST 是一個「經過修改、重寫和重新解釋的結構化文字」 。
格式簡單,源文件容易閱讀和編輯。適合撰寫筆記,使作者的注意力集中於撰寫內容而非形式 。
採用輕量級標記語言的文檔很容易轉換為其他文檔,例如PDF、HTML等,被很多軟體網站用來製作文檔,例如python的官方文檔採用reStructuredText語言。
可將文件內的文字以特別的形式標記( quickref ),稱為內聯標記( inline markup ),如下圖所示。內聯標記(inline markup)型式及使用方法就像是括號一般,標記符號立即標示在文字的前、後,符號與文字間不可留有空格;另外,在文字間的標記符號無法被識別,故失去標記的作用。例如:輸入「這是*斜體*字」輸出的結果亦為「這是*斜體*字」,不會使斜體兩字呈現斜體的效果。
雙反引號( double back-quotes )標記:反引號( back-quote )按鍵位在"esc"鍵下方。
超連結、註解可參考下方圖例中的兩種做法。( 須注意預留的空格 )
若需使用特殊字符,可以在特殊字符前方加上一個反斜線( backslash:\ )或者以雙反引號將特殊字符標記起來。例如:\*斜體* (或者``*斜體*``),文字不會以斜體呈現,而是顯示為「*斜體*」。( quickref )
清單的主要類型有:列舉清單(enumerated list)、項目符號清單(bulleted list)、定義(definitions)。在所有列表情況下,可以根據需要安排任意數量的段落,子列表等,只要該段落的左側或與列表項中第一行文本對齊即可。
列表均是以新段落開頭,即在第一個項目之前和最後一個項目之後,必須要有空白行(blank line),但項目之間則不強制。
1. 列舉清單(enumerated list ; quickref ):如下圖所示。
2. 項目符號清單(bulleted list ; quickref ):如下圖所示。
3. 定義(definitions ; quickref ):如下圖所示。
1. 段落的最後出現兩個冒號"::"時,後方表示接著縮排或加加引號的部分為文字塊(literal blocks)。
2. 文字塊必須"縮排"或"加引號"( valid quoting characters : ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ )。
3. 在文字塊內不執行任何標記處理,並保持原樣(as-is),且通常以等寬字體顯示。
4. 僅包含"::"的段落在輸出中完全不會顯示。