Écrire votre doc sous Eclipse avec le plugin Markdown Editor

Markdown est un langage permettant d’écrire de la documentation au travers d’un formalisme proche du texte pur et permettant la génération automatique de fichier PDF, HTML et autre.

Cella permet en autre d’écrire en une seule fois une documentation, pour l’intégrer en HTML dans votre application, tout en fournissant le même contenu en PDF.
Plus besoin de maintenir deux fichiers ! Et la conversion vers le PDF est aussi bonne que celle du HTML, au contraire de certains outils de conversion HTML vers PDF.

Installation du plugin : Markdown Text Editor

Vous trouverez le plugin chez Eclipse  http://marketplace.eclipse.org/content/markdown-text-editor .
Vous pouvez l’installer directement en déplacer l’icône suivant dans une instance d’Eclipse : Déplacer vers Eclipse démarré pour installer le plugin

Utilisation

L’installation faite, relancée Eclipse, crée un fichier d’extension :  » .mdown », « .markdown »

Eclipse Markdown Editor Exemple

Il se peut que l’éditeur « Markdown » ne soit pas activé par défaut sur vos fichiers Markdown, en particulier si vous possédez le plugin « WikiText Editor« . Pour l’activer faite un clic droit sur le fichier  puis choisir « Open With/Markdown Editor » :

Eclipse Markdown Editor menu

Dans la vue « Outline » (sur la gauche dans l’image) vous trouverez la table des matières de votre documentation.

Dans la vue Markdown vous aurez un aperçu HTML de votre texte. Si cette dernière n’est pas affichée ajouter la vue « Markdown/Markdown view » depuis le menu Eclipse : « Window/Show view/Other« .

Vous trouverez les préférences du plugin dans le menu « Window/Preferences » puis « General/Editors/Text Editors/Markdown » :

Eclipse Markdown Editor Preferences

Exemple de code Markdown :

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3

Titre niveau 1
==============
Titre niveau 2
--------------
Ceci est **texte important**, ou  __texte important__, j'insiste !

* puce 1
    * sous puce
* puce 2

>Ceci est une citation  

lien vers le site de [Multimédia Solutions](http://www.lug.com "titre facultatif du lien : info bulle")

Exemple de code

    int main(){
        printf("Bonjour\n");
        return 0;
    }