Comment écrire un article en reStructuredText

Comme je l'expliquais dans mon article précédent notre nouveau blog nécessite que l'on écrive les articles dans un format spécifique appelé reStructuredText. Il s'agit d'un langage de balisage qui permet, à l'aide d'une syntaxe simpliste, de formater son texte de façon claire.

L'extension des fichiers au format reStructuredText est ".rst".

Un article doit toujours débuter par le bloc suivant :

Titre de l'article
###############################################
:date: 2013-01-12 10:00
:tags: tag1 tag2 tag3 ...
:slug: titre-de-l-article        (url de l'article de préférence garder le titre)
:author: Tarik Dadi
:email: name@mail.com
:about_author: Engineering student, Looking for an internship <div></div> <a href="http://www.monsiteweb.com">My website</a>

Faites en sorte que votre adresse mail soit enregistrée sur Gravatar afin que votre avatar s'affiche à coté des articles que vous rédigerez.

Vous pouvez ensuite commencer à rédiger votre article en utilisant la syntaxe reStructuredText pour mettre en forme votre article. Je vais vous présenter quelques exemples de ce qui est réalisable :

Titre
=====
Sous-titre
-----------

Ce qui donne :

Titre

Sous-titre

Enumerated lists:

3. This is the first item
4. This is the second item


Bullet lists:

- This is item 1
- This is item 2

Enumerated lists:

3. This is the first item
4. This is the second item

Bullet lists:

• This is item 1
• This is item 2

Lien vers un site web, tel que `Python <http://www.python.org/>`_.

Lien vers un site web, tel que Python.

.. image:: images/logo.png

*italique*  italique

``inline literal``

**gras**  gras

italique italique

inline literal

gras

Vous trouverez une documentation reStructuredText plus exhaustive en suivant ce lien ReST Doc.

Coloration syntaxique

Afin d'insérer des exemples de code dans vos articles en profitant de la coloration syntaxique fournie par le plugin Pygments, il faut utiliser la syntaxe suivante :

.. code-block:: python

    print("Hello, World!")


.. code-block:: c

    #include <stdio.h>

    int main(void) {
        printf("Hello, world!\n");
        return 0;
    }

print("Hello, World!")

#include <stdio.h>

int main(void) {
    printf("Hello, world!\n");
    return 0;
}

Pour connaître les langages supportés par Pygments suivez ce lien.

--