reStructuredText語法簡單說明


reStructuredText 是擴展名為.rst的純文本文件,含義為"重新構建的文本"",也被簡稱為:RST或reST。

官方網址:

http://docutils.sourceforge.net/rst.html

rst用戶手冊:

http://docutils.sourceforge.net/rst.html#user-documentation

http://docutils.sourceforge.net/docs/user/rst/quickref.html

rst 文件是輕量級標記語言的一種,被設計為容易閱讀和編寫的純文本,並且可以借助Docutils這樣的程序進行文檔處理,也可以轉換為HTML或PDF等多種格式, 或由Sphinx-Doc這樣的程序轉換為LaTex、man等更多格式。

這里記錄下常見的語法,更多內容請參考官方手冊。

標題

可以表示標題的符號有:

= - ` : ' " ~ ^ _  * + # < >

示例如下:

標題
=================================================

一級標題
-------------------------------------------------

二級標題
`````````````````````````````````````````````````

效果如下:

段落

段落是被空行分割的文字片段,左側必須對齊(沒有空格,或者有相同多的空格)。

列表

可以表示列表的符號有:

-、*、+

不同的符號結尾需要加上空行,下級列表需要有空格縮進。

示例如下:

- 列表1

    - 子列表1

    * 子列表2

    + 子列表3

* 列表2

+ 列表3

效果如下:

  • 列表1

    • 子列表1
    • 子列表2
    • 子列表3
  • 列表2
  • 列表3

代碼塊(文字塊)

在需要插入文本塊的段落后面加上 :: ,接着一個空行,然后就是文字塊了。 文字塊開頭要有縮進,結束標志是新的一段文本貼開頭(即沒有縮進)。

示例如下:

::

    import os
    os.system("ls")

效果如下:

import os
os.system("ls")

超鏈接

reStructuredText會自動將網址生成超鏈接。

比如:

https://github.com/mike-zhang

https://github.com/mike-zhang

另外一種形式:

`mikeGithub <https://github.com/mike-zhang>`_

mikeGithub

圖片

示例如下:

.. image:: images/1.png

粗體和斜體

這是 **粗體** ,這是 *斜體*
不留白的\ **粗體**\ 和\ *斜體*\

這是 粗體 ,這是 斜體

不留白的粗體斜體

上標和下標

- Water: H\ :sub:`2`\ O
- E = mc\ :sup:`2`

rst簡單示例

rst簡單示例如下:

文章標題
===================================================

操作系統 : CentOS7.3.1611_x64

gcc版本 :4.8.5

go 版本 : go1.8.3 linux/amd64

Python 版本 : 2.7.5


一級標題
--------------------------------------
二級標題
`````````````````````````````````````````````````

- 列表1

- 列表2

代碼塊
::

    import os
    os.system("ls")

圖片:

.. image:: images/20120604.1.1.png

超鏈接:

https://github.com/mike-zhang

`mikeGithub <https://github.com/mike-zhang>`_

本文github地址:

https://github.com/mike-zhang/mikeBlogEssays/blob/master/2018/20180905_reStructuredText語法簡單說明.rst

歡迎補充


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM