Using ReStructuredText in INGInious

This guide gives some examples on how to use ReStructuredText in INGInious.

Admonitions - warnings, tips, …

The following warning/tips/… can be displayed using the code given below. INGInious is able to parse standard RST admonitions (which are displayed as bootstrap alerts).

We also introduced a new option, :title:, which allows providing a title. In case a title is given, the admonitions are displayed as bootstrap cards.

Example

A custom danger title
Beware killer rabbits!
A custom warning title
Water is humid!
You may need this
Take this tip with you
Some note
Write something here
Bravo!
You succeeded!
Now in blue
Some blue for you
Now in grey
Some grey for you
Some dark in the light
...
Beware killer rabbits!
Water is humid!
Take this tip with you
You succeeded!
Some blue for you
...

Code

.. danger::
   :title: A custom danger title

   Beware killer rabbits!

.. warning::
   :title: A custom warning title

   Water is humid!

.. tip::
   :title: You may need this

   Take this tip with you

.. note::
   :title: Some note

   Write something here

.. admonition:: success
   :title: Bravo!

   You succeeded!

.. admonition:: primary
   :title: Now in blue

   Some blue for you

.. admonition:: secondary
   :title: Now in grey

   Some grey for you

.. admonition:: dark
   :title: Some dark in the light

   ...

.. danger::
   Beware killer rabbits!

.. warning::
   Water is humid!

.. tip::
   Take this tip with you

.. admonition:: success

   You succeeded!

.. admonition:: primary

   Some blue for you

.. admonition:: dark

   ...

Hidden-until

hidden-until is a special directive to give feedback after a given date is reached. The recommended format to indicate the date is YYYY-MM-DD hh:mm:ss.

.. hidden-until:: 2020-01-01 12:00:03

    This sentence will only be displayed after the 1st January 2020 at 12:00:03.