From be12f2009759514fdcf6bfc70cc62f4cc60c651b Mon Sep 17 00:00:00 2001 From: Martin Damien Date: Sun, 26 Jun 2016 15:34:16 +0200 Subject: [en/RST] Add RST introduction (#1723) * [en/RST] Add RST introduction * Fix @ in username --- rst.html.markdown | 107 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 rst.html.markdown (limited to 'rst.html.markdown') diff --git a/rst.html.markdown b/rst.html.markdown new file mode 100644 index 00000000..161a0610 --- /dev/null +++ b/rst.html.markdown @@ -0,0 +1,107 @@ +--- +language: restructured text +contributors: + - ["DamienVGN", "https://github.com/martin-damien"] +filename: restructuredtext.rst +--- + +RST is 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). + + +## Installation + +To use Restructured Text, you will have to install [Python](http://www.python.org) and the `docutils` package. + +`docutils` can be installed using the commandline: + +```bash +$ easy_install docutils +``` + +If your system have `pip`, you can use it too: + +```bash +$ pip install docutils +``` + + +## File syntaxe + +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 + +========================================================= +Main titles are written using equals signs over and under +========================================================= + +Note that theire must be as many equals signs as title characters. + +Title are underlined with equals signs too +========================================== + +Subtitles with dashes +--------------------- + +And sub-subtitles with tilde +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +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: + +- First item +- Second item + - Sub item + +or + +* First item +* Second item + * Sub item + +Tables are really easy to write: + +=========== ======== +Country Capital +=========== ======== +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 :) + +Their is 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 `_ . + +.. _Github https://github.com/ + +``` + + +## How to use it + +RST comes with docutils in which you have `rst2html` for exemple: + +```bash +$ 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: + +- [Pelican](http://blog.getpelican.com/), a static site generator +- [Sphinx](http://sphinx-doc.org/), a documentation generator +- and many others + + +## Readings + +- [Official quick reference](http://docutils.sourceforge.net/docs/user/rst/quickref.html) -- cgit v1.2.3 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