Comment savoir si je dois utiliser une bibliothèque Markdown?

Question

J'ai constaté que de nombreux projets Github utilisent Markdown . A l'origine, je pensais que cette bibliothèque n'était nécessaire que sur des sites tels que StackOverflow, qui permettent aux utilisateurs d'ajouter des commentaires ou des publications pouvant inclure des extraits de code source. Mais certaines applications semblent utiliser Markdown même lorsque ce n'est pas le cas.

  

Markdown est un balisage léger   langage, créé à l'origine par John   Gruber et Aaron Swartz pour aider   lisibilité maximale et   " aptitude à la publication " de son entrée et   formulaires de sortie. La langue prend beaucoup   indications des conventions existantes pour   marquer le texte brut dans l'email.   Markdown convertit son texte balisé   entrée pour valider, bien formé XHTML et   remplace les équerres à gauche   ('<') et des esperluettes avec leurs   entité de caractère correspondante   références.

J'écris actuellement une application Web qui offre aux utilisateurs la possibilité d'ajouter des commentaires. Est-il possible que je devrais utiliser Markdown pour cela, même si les commentaires ne contiennent pas de code source?

Answer 1

Le besoin de Markdown n’a rien à voir avec la possibilité d’inclure du code source. C'est juste un moyen de formater du texte, dans un format simple, lisible même lorsque le formateur n'est pas disponible. Historiquement, le logiciel de forum utilisait pour cela le code BB, ce qui est assez encombrant pour de nombreux utilisateurs et n’offre pas le & "; Lisible &"; fonctionnalité.

Quoi qu'il en soit, la question que vous devez vous poser, dans ce cas, est la suivante: souhaitez-vous permettre à vos utilisateurs de formater les commentaires? Si oui, vous avez besoin de certaines bibliothèques de formatage. Markdown peut être une bonne idée alors. Cela correspond à la façon dont les gens ont de toute façon tendance à annoter dans des environnements contenant uniquement du texte, par exemple en entourant du texte souligné par des astérisques ou des traits de soulignement.

C'est aussi une sorte de protection, car il remplace le balisage HTML par des entités, empêchant essentiellement les attaques par scripts.

Answer 2

Si vous souhaitez que vos utilisateurs puissent saisir du texte gras ou italique , ou inclure liens vers d'autres pages , puis la prise en charge de Markdown est un bon moyen de le faire. Que ce soit quelque chose que vous voulez soutenir est à vous, mais c'est utile, OMI.