Phenquestions
Il Markdown standard
Markdown è uno standard sviluppato da John Gruber. L'obiettivo principale con Markdown è rendere il file leggibile anche in puro testo. Se vuoi cercare in un editor di solo testo, dovresti divertirti a leggerlo. Questo è molto utile per gli utenti di vim e simili. Nota e ricorda che questo è uno standard per modificare i file di testo. Non sostituisce l'HTML. Invece, lo usi per creare HTML dove è utile. Nel caso di GitHub, formatteranno il file Leggimi sul sito. Finché segui lo standard, puoi essere certo che avrà un bell'aspetto.
Poiché GitHub ha aggiunto solo alcune estensioni, dovresti iniziare utilizzando un cheatsheet di Markdown e andare da lì. Ecco un elenco dei più comuni.
| Ribasso | Estensioni | Risultato |
| # (1 per livello) | intestazioni | |
| * | Corsivo | |
| ** | Grassetto | |
| > | citazione | |
| 1. (eccetera.) | Lista ordinata | |
| - | Lista non ordinata | |
| 'codice' | Il tuo codice | |
| “' | Md-ext | Inizia e termina un blocco di codice |
| - | Regola orizzontale | |
| [Descrizione](https://www.esempio.it) | Un nome in quadrato e un URL tra parentesi regolari | |
|  | Idem, link a un'immagine | |
| [1] | Md-ext | Una nota a piè di pagina |
Gli elenchi possono essere nidificati facendo rientrare gli elementi che si desidera nidificare.
Altre estensioni al normale Markdown, hai le estensioni dei blocchi di codice sopra. Non sono sempre supportati dai servizi.
| Ribasso | Estensioni | Risultato |
| ### Intestazione #custom-id | Md-ext | Un'intestazione che puoi indirizzare tramite il suo ID |
| termine: definizione | Md-ext | Un elenco di termini con definizioni |
| ~Testo sbagliato~ | Md-ext | Testo barrato |
| - [x] Compito da fare | Md-ext | Un elenco di attività che puoi spuntare |
La tabella è molto semplice, ma sono necessarie più righe per visualizzarla: Tabella:
| Nome | VALORE|| ----------- | ---------- |
| Tappetini | 100 |
Estensioni GitHub.
GitHub ha aggiunto alcune estensioni per semplificare la gestione dei collegamenti ad altre persone e progetti. Alcune di queste sono le tabelle menzionate prima. Quello che ti aiuterà di più è l'estensione di collegamento automatico. Crea un collegamento da solo quando lo usi su GitHub.
Altri sono tabelle e voci dell'elenco delle attività. Questi sono utili per tenere traccia delle tue attività nei progetti. L'ultimo da menzionare è l'estensione HTML raw non consentita. Con l'aiuto di questa estensione, alcuni tag vengono filtrati durante il rendering per HTML. Questi tag possono causare strani effetti durante il rendering su GitHub.
Modi per esplorare GitHub Markdown
Se lo trovi confuso, puoi anche andare alla pagina GitHub e utilizzare l'editor integrato. Quando lo usi, completerà automaticamente alcune funzioni. Funziona solo per problemi, ma puoi usarlo per capire alcune cose, gli emoji vengono visualizzati come un elenco quando digiti i due punti (:).
Puoi anche trovare un progetto su GitHub che ha un file README di bell'aspetto e clonarlo sul tuo disco locale. Da lì, puoi esplorare il file usando qualsiasi editor che desideri. Per i grandi editor, Emacs e Vim, c'è il supporto per il markdown tramite estensioni.
Se stai usando vim, puoi inserire un'estensione di evidenziazione della sintassi da GitHub, vim-markdown. Questa estensione ti mostra che hai fatto il codice correttamente. Per aiutarti a vedere come appare una volta terminato, puoi anche ottenere l'estensione live mark live. Con questo, puoi avere un server web in esecuzione, che mostra il risultato in tempo reale mentre digiti.
Con Emacs, hai la modalità impaziente, la modalità live down e l'anteprima in tempo reale. Mostrano tutti la pagina risultante in un browser mentre digiti. Il primo richiede meno librerie rispetto al secondo ma necessita di uno snippet di codice aggiuntivo per essere eseguito.
Conclusione
Anche se il markdown è una specifica piccola e volutamente semplice, può essere un po' confuso iniziare con. Il modo migliore per imparare è usare un cheat sheet e scrivere il tuo documento Markdown. Puoi aggiornare il tuo README.md su GitHub e puoi ottenere molto supporto dalle funzioni integrate dei tuoi editor. Come nota a margine, GitHub supporta anche gli emoji che puoi aggiungere al tuo documento. Puoi usare il cheat sheet per scoprire quali sono.
Scarica Markdown-CheatSheetQui
