From df0d0a24026c071986f9c357690e5cda7a73dd6e Mon Sep 17 00:00:00 2001 From: Andrew DiMola Date: Mon, 15 Apr 2019 15:46:38 -0400 Subject: Update rst.html.markdown MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- rst.html.markdown | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'rst.html.markdown') 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: -- cgit v1.2.3 From be7cf6dabfeec7849f477edb00700d2bc698cadb Mon Sep 17 00:00:00 2001 From: Andrew DiMola Date: Mon, 15 Apr 2019 16:02:39 -0400 Subject: Update rst.html.markdown Separated sentences for readability / line length. --- rst.html.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 83308efa..2423622e 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -49,7 +49,9 @@ Subtitles with dashes You can put text in *italic* or in **bold**, you can "mark" text as code with double backquote ``print()``. -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. +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 -- cgit v1.2.3