jyapayne/nimforum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

repurpose rst.txt as rst help

Browse source
This commit is contained in:
stisa 2017-10-07 17:32:34 +02:00
commit d441f9445d
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
rst.txt → static/rst.rst
View file

@ -3,7 +3,7 @@
=========================================================================== ===========================================================================
This is a cheat sheet for the *reStructuredText* dialect as implemented by This is a cheat sheet for the *reStructuredText* dialect as implemented by
Nimrod's documentation generator which has been reused for this forum. :-) Nim's documentation generator which has been reused for this forum.
See also the See also the
`official RST cheat sheet <http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt>`_ `official RST cheat sheet <http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt>`_
@ -32,14 +32,14 @@ Plain text Result
Links Links
===== =====
Links are either direct URLs like ``http://nimrod-lang.org`` or written like Links are either direct URLs like ``http://nim-lang.org`` or written like
this:: this::
`Nimrod <http://nimrod-lang.org>`_ `Nim <http://nim-lang.org>`_
Or like this:: Or like this::
`<http://nimrod-lang.org>`_ `<http://nim-lang.org>`_
Code blocks Code blocks
@ -47,7 +47,7 @@ Code blocks
are done this way:: are done this way::
.. code-block:: nimrod .. code-block:: nim
if x == "abc": if x == "abc":
echo "xyz" echo "xyz"
@ -55,25 +55,25 @@ are done this way::
Is rendered as: Is rendered as:
.. code-block:: nimrod .. code-block:: nim
if x == "abc": if x == "abc":
echo "xyz" echo "xyz"
Except Nimrod, the programming languages C, C++, Java and C# have highlighting Except Nim, the programming languages C, C++, Java and C# have highlighting
support. support.
An alternative github-like syntax is also supported. This has the advantage An alternative github-like syntax is also supported. This has the advantage
that no excessive indentation is needed:: that no excessive indentation is needed::
```nimrod ```nim
if x == "abc": if x == "abc":
echo "xyz"``` echo "xyz"```
Is rendered as: Is rendered as:
.. code-block:: nimrod .. code-block:: nim
if x == "abc": if x == "abc":
echo "xyz" echo "xyz"