Cleaned up spelling and writing style

This commit is contained in:
morristheaverage 2020-09-25 16:55:02 +01:00
parent 325ebb8543
commit ef3b6dc104

View File

@ -3,12 +3,13 @@ language: restructured text (RST)
contributors: contributors:
- ["DamienVGN", "https://github.com/martin-damien"] - ["DamienVGN", "https://github.com/martin-damien"]
- ["Andre Polykanine", "https://github.com/Oire"] - ["Andre Polykanine", "https://github.com/Oire"]
- ["Tom Morris", "https://github.com/morristheaverage"]
filename: restructuredtext.rst 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 ## Installation
@ -39,10 +40,10 @@ A simple example of the file syntax:
Main titles are written using equals signs over and under 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 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: 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 typing a full comprehensible URL : https://github.com/ (will be automatically converted to a link)
- By making a more Markdown-like link: `Github <https://github.com/>`_ . - By making a more Markdown-like link: `Github <https://github.com/>`_ .