reStructuredText is a great markup language used in the Python world but can also be used for general text activities. It has more specificity in its design and has more functionality when compared to others in its class such as Markdown.
It is the format for content for this website since I use the Pelican static site generator which natively uses RST format for writing content.
The below is a side-by-side comparison of most of the reStructuredText elements and their equivalent when processed; in this case pandoc was used to convert from RST to html. This list also does not include all forms of each element - for the complete specification see the link above.
- inline markup
- paragraph
- bullet list
- enumerated list
- definition list
- field list
- literal block
- line block
- block quote
- table (simple)
- table (grid)
- footnotes
- citation
- hyperlink (internal)
- hyperlink (external)
- hyperlink (embedded)
- directive substitution
| reStructuredText | Result | ||||||||
|---|---|---|---|---|---|---|---|---|---|
*emphasis* **strong emphasis** `interpreted text` ``inline literal text`` |
emphasis strong emphasis interpreted text
|
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat. |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat. |
||||||||
- Lorem ipsum dolor sit amet - Pellentesque ornare - Pellentesque vitae nulla gravida tempor eget in sapien - Nunc euismod tellus turpis, efficitur non. |
|
||||||||
A. Lorem ipsum dolor sit amet,
consectetur adipiscing elit.
B. Pellentesque ornare commodo
C. Pellentesque vitae nulla
gravida tempor eget in sapien
a. Lorem ipsum dolor sit amet,
consectetur adipiscing elit.
b. Pellentesque ornare commodo
i. Lorem ipsum dolor sit amet,
consectetur adipiscing elit.
ii. Pellentesque ornare commodo
est eget tempor.
|
|
||||||||
Lorem ipsum
dolor sit amet
consectetur adipiscing elit.
Pellentesque
ornare commodo est eget tempor.
|
|
||||||||
:Lorem ipsum:
dolor sit amet
consectetur adipiscing elit.
:Pellentesque:
ornare commodo est eget tempor.
:Vestibulum:
- vitae arcu ex
- Fusce aliquet faucibus rutrum
- Integer at tortor tellus
|
|
||||||||
Duis imperdiet id orci quis consequat.
Nam in sem consequat, laoreet enim ut,
aliquet nibh. Sed vitae sem ipsum.
Aliquam nec gravida dolor. ::
Morbi mollis vitae mauris ac interdum.
Pellentesque id posuere magna, fermentum
Nam libero lacus, elementum eu faucibus
aliquet, venenatis quis augue.
Quisque rutrum arcu elit, sed tempor
sed. Donec bibendum sit amet libero
|
Duis imperdiet id orci quis consequat. Nam in sem consequat, laoreet enim ut, aliquet nibh. Sed vitae sem ipsum. Aliquam nec gravida dolor. : Morbi mollis vitae mauris ac interdum. Pellentesque id posuere magna, fermentum Nam libero lacus, elementum eu faucibus aliquet, venenatis quis augue. Quisque rutrum arcu elit, sed tempor sed. Donec bibendum sit amet libero |
||||||||
| Duis imperdiet id orci quis consequat. | Nam in sem consequat, laoreet enim ut | | Sed vitae sem ipsum. Aliquam nec | mauris ac interdum. Pellentesque | fermentum dapibus purus. | eu faucibus aliquet |
Duis imperdiet id orci quis consequat.
Nam in sem consequat, laoreet enim ut Sed vitae sem ipsum. Aliquam nec mauris ac interdum. Pellentesque fermentum dapibus purus. eu faucibus aliquet |
||||||||
Duis imperdiet id orci quis consequat.
Nam in sem consequat, laoreet enim ut,
Morbi mollis vitae mauris ac interdum.
Pellentesque id posuere magna, fermentum dapibus purus.
Nam libero lacus, elementum eu faucibus
aliquet, venenatis quis augue.
-- Morbi mollis
|
Duis imperdiet id orci quis consequat. Nam in sem consequat, laoreet enim ut,
|
||||||||
================== ======================= Morbi mollis vitae mauris ================== ======================= Pellentesque id posuere magna fermentum dapibus purus Nam libero aliquet, venenatis quis ================== ======================= |
|
||||||||
+------------------+---------------------------+ | Morbi mollis | vitae mauris | +==================+===========================+ | Pellentesque | | +------------------+---------------------------+ | id posuere magna | fermentum dapibus purus | +------------------+---------------------------+ | Nam libero | aliquet, venenatis quis | +------------------+---------------------------+ |
|
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit [1]_. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat [2]_. .. [1] Lorem ipsum dolor sit amet .. [2] Duis imperdiet id orci quis consequat. |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit1. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat2. |
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit [Lorem1]_. .. [Lorem1] Lorem ipsum dolor sit amet |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit [Lorem1].
|
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit. .. _internal1: The previous line specifies a hyperlink target which links to this paragraph by giving it an id. Later on to link to this paragraph, use internal1_. |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. Pellentesque vitae nulla velit. The previous line specifies a hyperlink target which links to this paragraph by giving it an id. Later on to link to this paragraph, use internal1. |
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. python_ pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat `asme home`_. .. _python: https://python.org .. _asme home: https://asme.org |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ornare commodo est eget tempor. python pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat asme home. |
||||||||
Click `here <https://asme.org>`_ for the ASME
home page.
|
Click here for the ASME home page. |
||||||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. |pellentesque| ornare commodo est eget tempor. Pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat. .. |pellentesque| math:: a^2 + xb^3 |
Lorem ipsum dolor sit amet, consectetur adipiscing elit. a2 + xb3 ornare commodo est eget tempor. Pellentesque vitae nulla velit. Praesent non nisl id eros gravida tempor eget in sapien. Curabitur vestibulum dapibus placerat. |