Documentation de l’éditeur Markdown

Cet article présente quelques astuces sur l’éditeur Markdown de Contentful, qui ne sont pas forcément évidentes au premier coup d’œil dans l’interface. Plus précisément, il explique les raccourcis clavier, l’organisation des liens, l’intégration des médias et le rendu HTML.

Utiliser les raccourcis clavier

Le temps et les efforts nécessaires pour apprendre les raccourcis sont généralement payants : vous pouvez faire les choses plus rapidement, car le clavier est plus confortable à utiliser qu’une souris ou un pavé tactile.

Voici les raccourcis pris en charge par l’éditeur. Si vous êtes sous Windows, appuyez sur Ctrl au lieu de Cmd.

• Cmd+Z - Annuler

• Cmd+R - Rétablir

• Cmd+B - Mettre le texte en gras

• Cmd+I - Mettre le texte en italique

• Tab - Mettre le texte en retrait

• Maj+Tab - Annuler le retrait du texte

• Échap - Quitter le mode plein écran

Organiser les liens

Il existe deux façons d’avoir des liens dans Markdown. La première est appelée liens en ligne:

Les URL sont placées directement dans le texte. Ça marche bien avec deux ou trois liens, mais dès qu’il y en a beaucoup, l’affichage devient difficile à gérer.

Autre option : regrouper tous les liens à la fin de l’article, comme ceci :

Au lieu de placer l’URL entière en ligne, vous n’utiliseriez que son numéro :

Si nous vous expliquons tout cela, c’est parce que l’éditeur Markdown peut organiser automatiquement les liens. Le bouton à utiliser est :  Organiser les liens

En cliquant sur ce bouton, vos liens intégrés se transforment automatiquement en références, et toutes les URL sont regroupées à la fin du document.

Intégrer du contenu multimédia avec embed.ly

Point de vue de l’auteur

Contentful permet d’intégrer de nombreux types de contenu multimédia externe, y compris, mais sans s’y limiter, des images, des vidéos, des tweets et des PDF, dans des textes au format Markdown. Cliquez sur Intégrer du contenu externe, collez le lien vers la ressource externe, et l’éditeur fera le reste. Bien que vous ne voyiez que l’extrait de code dans le mode d’édition de texte, l’aperçu affichera la ressource multimédia telle qu’elle devrait apparaître.

Consultez la liste des services pris en charge.

Point de vue du développeur

Nous utilisons Embedly pour afficher du contenu externe. Pour afficher les cartes Embedly dans vos sites et applications, vous devez utiliser les bibliothèques pertinentes fournies par Embedly. Consultez la documentation pour plus d’informations.

Utiliser HTML lorsque Markdown ne suffit pas

Aussi bonne que soit la syntaxe Markdown, elle ne peut pas tout faire. C’est certain, la mise en forme des tableaux dans Markdown n’est pas très agréable. Il est également impossible de définir une taille d’image personnalisée dans Markdown.

HTML peut être utile dans ces cas. Certes, il n’est pas utile pour les développeurs qui devront traiter le contenu que vous leur préparez, mais il peut donner à l’éditeur une compréhension de base de l’aspect du contenu fini.

L’éditeur Markdown de Contentful prend en charge les balises HTML de base. Nous vous encourageons à formater le contenu avec le balisage Markdown, mais il est parfois difficile d’éviter d’écrire cette  balise <img src="../screenshot-3.png" width="400"/>.