Come faccio a sapere se devo usare una libreria Markdown?

Question

Ho scoperto che molti progetti Github utilizzano Markdown . Inizialmente pensavo che questa libreria fosse necessaria solo su siti come StackOverflow che includono la possibilità per gli utenti di aggiungere commenti o post che potrebbero includere frammenti di codice sorgente. Ma alcune app sembrano usare Markdown anche quando non è così.

  

Markdown è un markup leggero   lingua, originariamente creata da John   Gruber e Aaron Swartz per aiutare   massima leggibilità e   quot &; & pubblicabilità quot; di entrambi i suoi input e   moduli di output. La lingua richiede molti   spunti da convenzioni esistenti per   contrassegnare il testo semplice tramite e-mail.   Markdown converte il testo marcato   input per XHTML valido e ben formato e   sostituisce le parentesi angolari rivolte a sinistra   ('<') e e commerciali con il loro   entità personaggio corrispondente   riferimenti.

Attualmente sto scrivendo un'app Web che include la possibilità per gli utenti di aggiungere commenti. È possibile che dovrei usare Markdown per questo, anche se i commenti non contengono codice sorgente?

Answer 1

La necessità di Markdown non ha nulla a che fare con la possibilità di includere il codice sorgente. È solo un modo per formattare il testo, in un formato semplice che è persino leggibile quando il formatter non è disponibile. Storicamente, il software del forum ha usato il codice BB per questo, che è abbastanza ingombrante per molti utenti e non offre il & Quot; leggibile & Quot; caratteristica.

In ogni caso, la domanda che devi porti, in questo caso, è: vuoi consentire ai tuoi utenti di formattare i commenti? In caso affermativo, è necessario alcuni libreria di formattazione. Markdown potrebbe essere una buona idea allora. Si allinea con il modo in cui le persone tendono comunque a eseguire il markup in ambienti di solo testo, come circondare il testo enfatizzato con asterischi o caratteri di sottolineatura.

È anche una sorta di protezione, poiché sostituisce il markup HTML con entità, in pratica prevenendo gli attacchi di scripting.

Answer 2

Se vuoi che i tuoi utenti siano in grado di inserire grassetto o corsivo o includere link ad altre pagine , quindi fornire supporto Markdown è un buon modo per farlo. Se questo è qualcosa che vuoi supportare dipende da te, ma è utile, IMO.