diff options
| author | Boris Verkhovskiy <boris.verk@gmail.com> | 2024-04-03 04:31:13 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-03 04:31:13 -0700 |
| commit | fbf132752b743d0f43c3395da0699bee53da22df (patch) | |
| tree | 56da43c86e1aebd24e3913b405e21d6f2812e9a3 /rst.html.markdown | |
| parent | 247dc6e86c1421fa031e4b61c42c05ca6e09bfb0 (diff) | |
| parent | c166f2acb295627c5ae305a6dd517a27ca8fece6 (diff) | |
Merge branch 'master' into patch-1
Diffstat (limited to 'rst.html.markdown')
| -rw-r--r-- | rst.html.markdown | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/rst.html.markdown b/rst.html.markdown index 56d54501..8a730c7a 100644 --- a/rst.html.markdown +++ b/rst.html.markdown @@ -8,7 +8,7 @@ filename: restructuredtext.rst 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 is a markdown language like HTML but is much more lightweight and easier to read. +RST is a markup language like HTML but is much more lightweight and easier to read. ## Installation @@ -33,7 +33,7 @@ $ pip install docutils A simple example of the file syntax: ``` -.. Lines starting with two dots 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 @@ -80,12 +80,12 @@ France Paris Japan Tokyo =========== ======== -More complex tables 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: - 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/>`_ . .. _Github: https://github.com/ |