Subscribe to News

ReStructureText Example

From TechnologicalWiki

Jump to: navigation, search

Example Documentation

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for inline program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is a proposed revision and reinterpretation of the StructuredText and Setext lightweight markup systems.

reStructuredText is designed for extensibility for specific application domains. Its parser is a component of Docutils.

More Examples

Tables are quite simple to read and create with reStructureText. Two table formats, grid and simple, are supported.

Grid Table Example 09:42, 18 September 2009 (UTC)09:42, 18 September 2009 (UTC)09:42, 18 September 2009 (UTC)[[Special:Contributions/88.26.177.14|88.26.177.14]]

Header 1 Header 2 Header 3
body row 1 column 2 column 3
body row 2 Cells may span columns.
body row 3 Cells may span rows.
  • Cells
  • contain
  • blocks.
body row 4

Simple Table Example 09:42, 18 September 2009 (UTC)09:42, 18 September 2009 (UTC)09:42, 18 September 2009 (UTC)09:42, 18 September 2009 (UTC)

Inputs Output
A B A or B
False False False
True False True
False True True
True True True

Still More Examples

Various formatting such as emphasis and strong emphasis and inline literal are supported. Links to external websites may be fully listed, http://www.google.com, or presented as anonymous links.

Lists are also easy to read and create:

  • item 1
  • item 2
  • item 3

When literal text is required, it can be created:

Whitespace, newlines, blank lines, and
all kinds of markup (like *this* or
\this) is preserved by literal blocks.

more info

Main Collaborators