7Titles are underlined (or over-
8and underlined) with a printing
9nonalphanumeric 7-bit ASCII
10character. Recommended choices
11are "``= - ` : ' " ~ ^ _ * + # < >``".
12The underline/overline must be at
13least as long as the title text.
15A lone top-level (sub)section
16is lifted up to be the document's
26http://docutils.sf.net/
34- Bullets are "-", "*" or "+".
35 Continuing text must be aligned
36 after the bullet and whitespace.
38Note that a blank line is required
39before the first item and after the
40last, but is optional between items.
443. This is the first item
454. This is the second item
465. Enumerators are arabic numbers,
47 single letters, or roman numerals
486. List items should be sequentially
49 numbered, but need not start at 1
50 (although not all formatters will
51 honour the first index).
52#. This item is auto-enumerated
58 Definition lists associate a term with
62 The term is a one-line phrase, and the
63 definition is one or more paragraphs or
64 body elements, indented relative to the
65 term. Blank lines are not allowed
66 between term and definition.
73 (and sundry other good-natured folks)
75:Version: 1.0 of 2001/08/08
76:Dedication: To my father.
80-a command-line option "a"
81-b file options can have arguments
83--long options can be long also
84--input=file long options can also have
86/V DOS/VMS-style options too
91A paragraph containing only two colons
92indicates that the following indented
93or quoted text is a literal block.
97 Whitespace, newlines, blank lines, and
98 all kinds of markup (like *this* or
99 \this) is preserved by literal blocks.
101 The paragraph containing only '::'
102 will be omitted from the result.
104The ``::`` may be tacked onto the very
105end of any paragraph. The ``::`` will be
106omitted if it is preceded by whitespace.
107The ``::`` will be converted to a single
108colon if preceded by text, like this::
110 It's very convenient to use this form.
112Literal blocks end when text returns to
113the preceding paragraph's indentation.
114This means that something like this
121Per-line quoting can also be used on
122unindented literal blocks::
124> Useful for quotes from email and
125> for Haskell literate programming.
130A paragraph containing only two colons
131indicates that the following indented
132or quoted text is a literal block.
136 Whitespace, newlines, blank lines, and
137 all kinds of markup (like *this* or
138 \this) is preserved by literal blocks.
140 The paragraph containing only '::'
141 will be omitted from the result.
143The ``::`` may be tacked onto the very
144end of any paragraph. The ``::`` will be
145omitted if it is preceded by whitespace.
146The ``::`` will be converted to a single
147colon if preceded by text, like this::
149 It's very convenient to use this form.
151Literal blocks end when text returns to
152the preceding paragraph's indentation.
153This means that something like this
160Per-line quoting can also be used on
161unindented literal blocks::
163> Useful for quotes from email and
164> for Haskell literate programming.
169Block quotes are just:
176Doctest blocks are interactive
177Python sessions. They begin with
178"``>>>``" and end with a blank line.
180>>> print "This is a doctest block."
181This is a doctest block.
188+------------+------------+-----------+
189| Header 1 | Header 2 | Header 3 |
190+============+============+===========+
191| body row 1 | column 2 | column 3 |
192+------------+------------+-----------+
193| body row 2 | Cells may span columns.|
194+------------+------------+-----------+
195| body row 3 | Cells may | - Cells |
196+------------+ span rows. | - contain |
197| body row 4 | | - blocks. |
198+------------+------------+-----------+
216A transition marker is a horizontal line
217of 4 or more repeated punctuation
222A transition should not begin or end a
223section or document, nor should two
224transitions be immediately adjacent.
229Footnote references, like [5]_.
230Note that footnotes may get
231rearranged, e.g., to the bottom of
233.. [5] A numerical footnote. Note there's no colon after the ``]``.
235Autonumbered footnotes are
236possible, like using [#]_ and [#]_.
237.. [#] This is the first one.
238.. [#] This is the second one.
240They may be assigned 'autonumber
241labels' - for instance,
242[#fourth]_ and [#third]_.
244.. [#third] a.k.a. third_
246.. [#fourth] a.k.a. fourth_
248Auto-symbol footnotes are also
249possible, like this: [*]_ and [*]_.
250.. [*] This is the first one.
251.. [*] This is the second one.
256Citation references, like [CIT2002]_.
257Note that citations may get
258rearranged, e.g., to the bottom of
261.. [CIT2002] A citation (as often used in journals).
263Citation labels contain alphanumerics,
264underlines, hyphens and fullstops.
265Case is not significant.
267Given a citation like [this]_, one
268can also refer to it like this_.
275External hyperlinks, like Python_.
276.. _Python: http://www.python.org/
278External hyperlinks, like `Python
279<http://www.python.org/>`_.
281Internal crossreferences, like example_.
284This is an example crossreference target.
286Python_ is `my favourite
287programming language`__.
288.. _Python: http://www.python.org/
292Titles are targets, too
293=======================
294Implict references, like `Titles are
301.. image:: images/ball1.gif
303The |biohazard| symbol must be used on containers used to dispose of medical waste.
304.. |biohazard| image:: biohazard.png
309.. This text will not be shown
310 (but, for instance, in HTML might be
311 rendered as an HTML comment)
313An "empty comment" does not
314consume following blocks.
315(An empty comment is ".." with
316blank lines before and after.)
319 So this block is not "lost",
320 despite its indentation.
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list