Magazine

Introduction à reStructuredText

Publié le 22 novembre 2010 par Free_culture

Pour éditer les articles avec Pelican, vous devrez utiliser la syntaxe reStructuredText ou Markdown .

J'ai choisi reStrucuturedText dont la documentation est peu être un peu plus fourni sur le web. Je vais vous expliquer les principales syntaxe pour pouvoir débuter tranquillement avec ce langage.

Structure de base d'un article sous Pelican

Pour commencer un article sous Pelican, il faut connaitre 4 choses :

  • l'auteur ;
  • la date en format anglais ;
  • la catégorie de l'article ;
  • le titre de l'article.

Rien de bien compliqué en somme. Ce qui donne pour cette article précisément :

Introduction à reStructuredText
###############################

:author: GUillaume
:date: 2010-11-22 17:15
:category: reStructuredText

Bien évidemment, il y a des moyens de se passer des trois variables que sont author, date et catégory, mais ceci nécessite de mettre un peu les mains dans le cambouis. Pour une introduction, je préfère faire simple, histoire que vous n'ayez pas de questions à vous poser. On verra par la suite comment s'en passer.

Les paragraphes

Pour les paragraphes, il n'y a rien de compliquer, il suffit de laisser une ligne entre les deux paragraphes.

Passer à la ligne ne suffit pas car vous continuerez sur la même ligne.

Donc on passe une ligne complète. OK ?

Pour être plus clair, voici comment j'ai écris ces paragraphes.

Pour les paragraphes, il n'y a rien de compliquer, il suffit de laisser une ligne entre les deux paragraphes.

Passer
à
la
ligne
ne
suffit
pas
car
vous
continuerez
sur
la
même
ligne.

Donc on passe une ligne complète. OK ?

Les sections

Pour les syntaxes de sections, ou comment définir les titres et sous-titres de nos documents.

Section Title

Section Title

Section Title

Section Title
Section Title

Et voici le code de tout ceci :

Section Title
*************

Section Title
=============

Section Title
-------------

Section Title
.............

Section Title
~~~~~~~~~~~~

Il y a aussi

Section Title
#############

Mais celle ci est réservée au titre de votre article en ce que concerne Pelican. Si vous l'utilisez dans l'article, il deviendra le titre même de l'article, et prendra le dessus sur le titre originel !

Les liens hypertextes

Pour les urls, il y a deux solutions relativement simples.

Le première tres basique : http://alexis.notmyidea.org/pelican/

Pour le deuxième, je vous propose un lien vers le blog d'Alexis, créateur de Pélican.

Et voilà le code :

Le première tres basique : http://alexis.notmyidea.org/pelican/

Pour le deuxième, je vous propose un lien vers le `blog d'Alexis <http://blog.notmyidea.org>`_, créateur de Pélican

Mise en forme de caractères

Pour la mise en forme de caractères, je vais vous en montrer trois bien pratiques :

  • italique ;
  • gras ;
  • caractères monospaces ;

obtenus comme ceci :

*italique* ;
**gras** ;
``caractères monospaces`` ;

Et voilà, cette petite introduction est terminée. reStrcuturedText n'est pas une syntaxe difficile à appréhender. En une bonne demi-heure d'étude, vous arrivez à faire à peut près ce que vous souhaitez.


Vous pourriez être intéressé par :

Retour à La Une de Logo Paperblog

Ces articles peuvent vous intéresser :

A propos de l’auteur


Free_culture 9 partages Voir son profil
Voir son blog

l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte

Dossier Paperblog