Come scrivere rapidamente la documentazione delle nostre applicazioni
La comprensione del linguaggio Markdown è diventato importante per gli sviluppatori, in quanto permette di scrivere in modo veloce e semplice e con la giusta formattazione istruzioni e documentazione varia per qualunque utilizzo, applicazione complesa.
È infatti utilizzata soprattutto per scrivere i file di default Readme.MD nei repository di GitHub. .md e .markdown sono il formato per i file scritti in Markdown.
Si tratta di un linguaggio di markup studiato per essere semplice in modo da poterlo scrivere in qualunque editor di testo, e che possa essere convertito in HTML
Vedremo di seguito la sua sintassi, affiancata dal corrispettivo in HTML
| Markup | HTML |
| Titolo ===== | <h1>Titolo</h1> |
| Sottotitolo ————— | <h2>Sottotitolo</h2> |
| Paragrafo | <p>Paragrafo</p> |
| *corsivo* | <p> <em>corsivo</em> </p> |
| **grassetto** | <p> <strong>grassetto</strong> </p> |
| `pre-formattato` | <p> <code>pre-formattato</code> </p> |
| [link](http://google.com) | <p> <a href=”http://google.com”>link</a> </p> |
|  | <p> <img src=”http://img.jpg” alt=”testo” title=”” /> </p> |
| * punto 1 * punto 2 * punto 3 | <ul> <li>punto 1</li> <li>punto 2</li> <li>punto 3</li> </ul> |
| 1. primo punto 2. secondo punto 3. terzo punto | <ol> <li>primo punto</li> <li>secondo punto</li> <li>terzo punto</li> </ol> |
Per convertire il codice da Markdown in HTML è possibile utilizzare tool online come Markdown Web Dingus
complimenti per il post, mi piace assai
🙂