mirror of
https://github.com/adambard/learnxinyminutes-docs.git
synced 2025-04-26 15:13:56 +00:00
[rst/en] Make formatting in comments consistent
Made formatting in comments consistent by adding 2 periods
This commit is contained in:
parent
442f4a679c
commit
a667cf9997
@ -33,7 +33,7 @@ $ pip install docutils
|
|||||||
A simple example of the file syntax:
|
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
|
Main titles are written using equals signs over and under
|
||||||
@ -80,12 +80,12 @@ France Paris
|
|||||||
Japan Tokyo
|
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:
|
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 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/>`_ .
|
||||||
|
|
||||||
.. _Github: https://github.com/
|
.. _Github: https://github.com/
|
||||||
|
Loading…
Reference in New Issue
Block a user