From 33b1476f38b7036eb16a20fbc43c8ef42b4bf4d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=20Polykanine=20A=2EK=2EA=2E=20Menelion=20Elens=C3=BA?= =?UTF-8?q?l=C3=AB?= Date: Fri, 6 Jan 2017 23:02:45 +0200 Subject: [rst/en] Correcting English language --- rst.html.markdown | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 161a0610..8897ec2f 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -5,9 +5,9 @@ contributors: filename: restructuredtext.rst --- -RST is file format formely created by Python community to write documentation (and so, is part of Docutils). +RST is a file format formely created by Python community to write documentation (and so, is part of Docutils). -RST files are simple text files with lightweight syntaxe (comparing to HTML). +RST files are simple text files with lightweight syntax (comparing to HTML). ## Installation @@ -20,25 +20,25 @@ To use Restructured Text, you will have to install [Python](http://www.python.or $ easy_install docutils ``` -If your system have `pip`, you can use it too: +If your system has `pip`, you can use it too: ```bash $ pip install docutils ``` -## File syntaxe +## File syntax A simple example of the file syntax: ```rst -.. Line with two dotes are special commands. But if no command can be found, the line is considered as a comment +.. Lines starting with two dots are special commands. But if no command can be found, the line is considered as a comment ========================================================= Main titles are written using equals signs over and under ========================================================= -Note that theire must be as many equals signs as title characters. +Note that there must be as many equals signs as title characters. Title are underlined with equals signs too ========================================== @@ -46,12 +46,12 @@ Title are underlined with equals signs too Subtitles with dashes --------------------- -And sub-subtitles with tilde +And sub-subtitles with tildes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can put text in *italic* or in **bold**, you can "mark" text as code with double backquote ``: ``print()``. -Lists are as simple as markdown: +Lists are as simple as in Markdown: - First item - Second item @@ -72,22 +72,22 @@ France Paris Japan Tokyo =========== ======== -More complexe tabless can be done easily (merged columns and/or rows) but I suggest you to read the complete doc for this :) +More complex tabless can be done easily (merged columns and/or rows) but I suggest you to read the complete doc for this :) -Their is multiple ways to make links: +There are multiple ways to make links: -- By adding an underscore after a word : Github_ and by adding the target after the text (this have the advantage to not insert un-necessary URL inside the readed text). -- By typing a full comprehensible URL : https://github.com/ (will be automatically converted in link) -- By making a more "markdown" link: `Github `_ . +- By adding an underscore after a word : Github_ and by adding the target URL after the text (this way has the advantage to not insert unnecessary URLs inside readable text). +- By typing a full comprehensible URL : https://github.com/ (will be automatically converted to a link) +- By making a more Markdown-like link: `Github `_ . .. _Github https://github.com/ ``` -## How to use it +## How to Use It -RST comes with docutils in which you have `rst2html` for exemple: +RST comes with docutils where you have `rst2html`, for example: ```bash $ rst2html myfile.rst output.html @@ -95,13 +95,13 @@ $ rst2html myfile.rst output.html *Note : On some systems the command could be rst2html.py* -But their is more complexe applications that uses RST file format: +But there are more complex applications that use the RST format: - [Pelican](http://blog.getpelican.com/), a static site generator - [Sphinx](http://sphinx-doc.org/), a documentation generator - and many others -## Readings +## Reading - [Official quick reference](http://docutils.sourceforge.net/docs/user/rst/quickref.html) -- cgit v1.2.3 From 96a46ef4c1f706a06e050bf5e39472c8ef744369 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=20Polykanine=20A=2EK=2EA=2E=20Menelion=20Elens=C3=BA?= =?UTF-8?q?l=C3=AB?= Date: Fri, 13 Jan 2017 23:54:30 +0200 Subject: Reverting to Readings as suggested by @sidgupta234; adding myself to contributors --- rst.html.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 8897ec2f..59a29daa 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -2,6 +2,7 @@ language: restructured text contributors: - ["DamienVGN", "https://github.com/martin-damien"] + - ["Andre Polykanine", "https://github.com/Oire"] filename: restructuredtext.rst --- @@ -102,6 +103,6 @@ But there are more complex applications that use the RST format: - and many others -## Reading +## Readings - [Official quick reference](http://docutils.sourceforge.net/docs/user/rst/quickref.html) -- cgit v1.2.3 From 56275f78b21fbda664b0214bd108bdcf3550e735 Mon Sep 17 00:00:00 2001 From: ven Date: Thu, 2 Mar 2017 12:22:30 +0100 Subject: fix #2680 --- rst.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 59a29daa..1fbff015 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -1,5 +1,5 @@ --- -language: restructured text +language: restructured text (RST) contributors: - ["DamienVGN", "https://github.com/martin-damien"] - ["Andre Polykanine", "https://github.com/Oire"] -- cgit v1.2.3 From 70f7c0e11909017c4c76adc30ba6ce9732a5b071 Mon Sep 17 00:00:00 2001 From: Adam Bard Date: Tue, 4 Jul 2017 13:23:42 -0700 Subject: Update rst.html.markdown --- rst.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 1fbff015..65f848ed 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -32,7 +32,7 @@ $ pip install docutils A simple example of the file syntax: -```rst +``` .. Lines starting with two dots are special commands. But if no command can be found, the line is considered as a comment ========================================================= -- cgit v1.2.3 From c8c351d1531f1e7a2507f233652a2e23a588ae66 Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Thu, 13 Sep 2018 00:47:08 +0530 Subject: Fix rst rendering issue, closes #2775 --- rst.html.markdown | 3 --- 1 file changed, 3 deletions(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 65f848ed..fbf9a069 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -47,9 +47,6 @@ Title are underlined with equals signs too Subtitles with dashes --------------------- -And sub-subtitles with tildes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - 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: -- cgit v1.2.3 From 7a415e2149e210783680e65154dcd55ede9dfbeb Mon Sep 17 00:00:00 2001 From: Qix Date: Mon, 8 Oct 2018 04:39:44 -0600 Subject: [rst/en] fix typo: tabless -> tables --- rst.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index fbf9a069..bfcb4e46 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -70,7 +70,7 @@ France Paris Japan Tokyo =========== ======== -More complex tabless can be done easily (merged columns and/or rows) but I suggest you to read the complete doc for this :) +More complex tables can be done easily (merged columns and/or rows) but I suggest you to read the complete doc for this :) There are multiple ways to make links: -- cgit v1.2.3 From 215d688c0616f5023cab98b6b1ff9735581f03ec Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Mon, 8 Oct 2018 21:31:25 +0530 Subject: Update rst.html.markdown Clarify marking text as code --- rst.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index bfcb4e46..01595fe4 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -47,7 +47,7 @@ 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: -- cgit v1.2.3 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 From 2df3917975e038bb2750227db19d1cc46bc3175e Mon Sep 17 00:00:00 2001 From: Isaac Virshup Date: Wed, 24 Jun 2020 16:55:02 +1000 Subject: [RST/en] Fix compile errors from link and escaping There were two issues here: * The non-inline link was used incorrectly, and should have a colon after the specifier. * A compile error was generated from having a non-escaped `*`. These can be verified by running `rst2html`: ```sh $ rst2html.py ./restructuredtext.rst tmp.html ./restructuredtext.rst:24: (WARNING/2) Inline emphasis start-string without end-string. ./restructuredtext.rst:59: (WARNING/2) malformed hyperlink target. ``` After adding the colon, and adding the escape ```sh $ rst2html.py ./restructuredtext.rst tmp.html $ ``` I've also added a sentence on escaping. --- rst.html.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 2423622e..bdc73c7a 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -49,9 +49,11 @@ Subtitles with dashes You can put text in *italic* or in **bold**, you can "mark" text as code with double backquote ``print()``. +Special characters can be escaped using a backslash, e.g. \\ or \*. + 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: +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 @@ -86,7 +88,7 @@ There are multiple ways to make links: - By typing a full comprehensible URL : https://github.com/ (will be automatically converted to a link) - By making a more Markdown-like link: `Github `_ . -.. _Github https://github.com/ +.. _Github: https://github.com/ ``` -- cgit v1.2.3 From ef3b6dc1040bbf518e35749417fa3ef6a9cf0c65 Mon Sep 17 00:00:00 2001 From: morristheaverage Date: Fri, 25 Sep 2020 16:55:02 +0100 Subject: Cleaned up spelling and writing style --- rst.html.markdown | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index bdc73c7a..8e32ff3f 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -3,12 +3,13 @@ language: restructured text (RST) contributors: - ["DamienVGN", "https://github.com/martin-damien"] - ["Andre Polykanine", "https://github.com/Oire"] + - ["Tom Morris", "https://github.com/morristheaverage"] filename: restructuredtext.rst --- -RST is a file format formely created by Python community to write documentation (and so, is part of Docutils). +RST, Restructured Text, is a file format created by the Python community to write documentation. It is part of [Docutils](https://docutils.sourceforge.io/rst.html). -RST files are simple text files with lightweight syntax (comparing to HTML). +RST is a markdown language like HTML but is much more lightweight and easier to read. ## Installation @@ -39,10 +40,10 @@ A simple example of the file syntax: Main titles are written using equals signs over and under ========================================================= -Note that there must be as many equals signs as title characters. +Note that each character, including spaces, needs an equals sign above and below. -Title are underlined with equals signs too -========================================== +Title use equals signs but are only underlined +============================================== Subtitles with dashes --------------------- @@ -84,7 +85,7 @@ More complex tables can be done easily (merged columns and/or rows) but I sugges There are multiple ways to make links: -- By adding an underscore after a word : Github_ and by adding the target URL after the text (this way has the advantage to not insert unnecessary URLs inside readable text). +- By adding an underscore after a word : Github_ and by adding the target URL after the text (this way has the advantage of not inserting unnecessary URLs in the visible text). - By typing a full comprehensible URL : https://github.com/ (will be automatically converted to a link) - By making a more Markdown-like link: `Github `_ . -- cgit v1.2.3 From d9608f8894302cc6a6a053a267fbc5b74ed5a523 Mon Sep 17 00:00:00 2001 From: morristheaverage Date: Fri, 25 Sep 2020 17:02:53 +0100 Subject: Cleaned up writing and a typo --- rst.html.markdown | 1 - 1 file changed, 1 deletion(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index 8e32ff3f..f63d4b2f 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -3,7 +3,6 @@ language: restructured text (RST) contributors: - ["DamienVGN", "https://github.com/martin-damien"] - ["Andre Polykanine", "https://github.com/Oire"] - - ["Tom Morris", "https://github.com/morristheaverage"] filename: restructuredtext.rst --- -- cgit v1.2.3 From ef8f40a46d3cb58fca005000a8ddfadbbc823c97 Mon Sep 17 00:00:00 2001 From: morristheaverage Date: Fri, 25 Sep 2020 17:05:28 +0100 Subject: Edited typos --- rst.html.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown index f63d4b2f..56d54501 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -41,8 +41,8 @@ Main titles are written using equals signs over and under Note that each character, including spaces, needs an equals sign above and below. -Title use equals signs but are only underlined -============================================== +Titles also use equals signs but are only underneath +==================================================== Subtitles with dashes --------------------- -- cgit v1.2.3