papakiteliatziar

ReStructured Text Cheat Sheet

Editing

  • Just edit and hit "Preview" to see what happens
  • Some simple special characters are used for typographic and web markup
  • Look at how other pages do it (and how this page does it)

italics - *italics*

bold - **bold**

Titles

To make a title, just write it on one line and underlign it with - or = on the next line, like you would do with an old typewriter:

Titles
-------

Line breaks

For addresses and other blocks of
text where you want to preserve
line breaks, you can put a | at the
start of each line.

How?

| something
| like this
| does it

Images

Images are included with something like this:

.. image:: images/name.jpg

which will be replaced with the image "name.jpg" out of the "images" folder.

Horizontal Lines

To insert a horizontal line, put in 5 or more dashes on a line by itself with an empty line before and after it, like this:

--------

result:

Footnotes

Footnotes show how intellectual and sophisticated you are:

They're easy to do [1]_

and then somewhere at the bottom of the page:

.. [1] if you know what you are doing

Note there is no ':' after the closing bracket. You can use # instead of the number, then they will auto-number. [1]

Block Quotes

Block quotes are done by indenting the paragraphs (put 2 or more spaces at the start of each line):

This is a funny (german) quote that I can't verify, attributed to Ronald Reagan:

  Wer morgens kalt duscht, der lügt auch sonst.

Which turns into:

This is a funny (german) quote that I can't verify, attributed to Ronald Reagan:

Wer morgens kalt duscht, der lügt auch sonst.

Reference

There is a full reference of these commands (and many more complicated ones) out there: http://docutils.sourceforge.net/docs/user/rst/quickref.html

[1]Of course you have to keep the references and the actual footnotes in order yourself!