diff options
author | Andrew DiMola <andrewdimola@gmail.com> | 2019-04-15 15:46:38 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-04-15 15:46:38 -0400 |
commit | df0d0a24026c071986f9c357690e5cda7a73dd6e (patch) | |
tree | d3a602ec58336aa90589554404a9c7036d35069a /rst.html.markdown | |
parent | 2dde374091366cb098e5d405daa9c4c4c469b6dc (diff) |
Update rst.html.markdown
Revising the section on creating lists with RST, as the syntax for list/sublist creation is not 1-1 with Markdown.
The current example is actually incorrect—any/all sublists must be separated from their parent list by blank lines (above and below). These sublists must also be properly indented in relation to the text of the above parent list.
References:
[1]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists
[2]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Diffstat (limited to 'rst.html.markdown')
-rw-r--r-- | rst.html.markdown | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/rst.html.markdown b/rst.html.markdown index 01595fe4..83308efa 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -47,19 +47,25 @@ Title are underlined with equals signs too Subtitles with dashes --------------------- -You can put text in *italic* or in **bold**, you can "mark" text as code with double backquote ``print()``. +You can put text in *italic* or in **bold**, you can "mark" text as code with double backquote ``print()``. -Lists are as simple as in Markdown: +Lists are similar to Markdown, but a little more involved—remember to line up list symbols (like - or *) with the left edge of the previous text block, and remember to use blank lines to separate new lists from parent lists. - First item - Second item - - Sub item + + - Sub item + +- Third item or * First item * Second item - * Sub item + + * Sub item + +* Third item Tables are really easy to write: |