GitHub Markdown Cheatsheet
Il markdown standard
Markdown è uno standard sviluppato da John Gruber. L'obiettivo principale con Markdown è rendere il file possibile per leggere anche nel testo puro. Se vuoi guardare in un editor solo testo, dovresti divertirti a leggerlo. Questo è molto utile per gli utenti di VIM e simili. Nota e ricorda che questo è uno standard per la modifica dei file di testo. Non sta sostituendo HTML. Invece, lo usi per creare HTML dove è utile. Nel caso di GitHub, formaleranno il file Readme sul sito. Finché segui lo standard, puoi sentirti sicuro che avrà un bell'aspetto.
Poiché GitHub ha aggiunto solo alcune estensioni, dovresti iniziare usando un markdown cheatheet e andare da lì. Ecco un elenco dei più comuni.
| Markdown | Estensioni | Risultato |
| # (1 per livello) | Intestazioni | |
| * | Corsivo | |
| ** | Grassetto | |
| > | Blockquote | |
| 1. (eccetera.) | Lista ordinata | |
| - | Lista non ordinata | |
| 'codice' | Il tuo codice | |
| "" | MD-EXT | Avvia e termina un blocco di codice |
| - | Regola orizzontale | |
| [Descrizione] (https: // www.esempio.com) | Un nome in quadrato e URL tra parentesi regolari | |
| ![alt text] (immagine.PNG) | Lo stesso, collegamento a un'immagine | |
| [1] | MD-EXT | Una nota a piè di pagina |
Gli elenchi possono essere nidificati rientrando tutti gli articoli che si desidera nidificati.
Altre estensioni per il markdown regolare, hai le estensioni dei blocchi di codice sopra. Non sono sempre supportati dai servizi.
| Markdown | Estensioni | Risultato |
| ### intestazione #custom-id | MD-EXT | Una rubrica che puoi affrontare dal suo ID |
| termine: definizione | MD-EXT | Un elenco di termini con le definizioni |
| ~ Testo errato ~ | MD-EXT | Testo di attacco |
| - [x] compito da fare | MD-EXT | Un elenco di attività che puoi spuntare |
La tabella è molto semplice, ma hai bisogno di diverse righe per mostrarlo: Tabella:
| Nome | Valore || ----------- | ---------- |
| Mats | 100 |
Estensioni di github.
GitHub ha aggiunto alcune estensioni per rendere più semplice gestire i collegamenti ad altre persone e progetti. Alcuni di questi sono le tabelle menzionate in precedenza. Quello che ti aiuterà di più è l'estensione automatica. Crea un link da solo quando lo usi su github.
Altri sono tabelle e elenchi delle attività. Questi sono convenienti per tenere traccia delle tue attività nei progetti. L'ultimo da menzionare è l'estensione HTML non consentita. Con l'aiuto di questa estensione, alcuni tag vengono filtrati durante il rendering per HTML. Questi tag possono causare strani effetti quando si regano a 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. Questo funziona solo per i problemi, ma puoi usarlo per capire alcune cose, gli emoji escono come un elenco quando si digita un colon (:).
Puoi anche trovare un progetto su GitHub che ha un file readme di bell'aspetto e clonalo sul tuo drive locale. Da lì, puoi esplorare il file utilizzando qualsiasi editor che desideri. Per i grandi redattori, EMACS e VIM, c'è supporto per Markdown attraverso estensioni.
Se stai usando VIM, puoi inserire un'estensione di evidenziazione della sintassi da GitHub, VIM-Markdown. Questa estensione ti mostra che hai fatto correttamente il codice. Per aiutarti a vedere come appare quando è finito, puoi anche ottenere l'estensione dal vivo. Con questo, puoi avere un server Web in esecuzione, mostrando il risultato in diretta mentre digiti.
Con EMACS, hai in modalità impaziente, in modalità giù e preview in tempo reale. Mostrano tutti la tua pagina risultante in un browser mentre digiti. Il primo richiede meno librerie di quest'ultima ma ha bisogno di un cambio di codice extra per essere eseguito.
Conclusione
Anche se Markdown è una specifica piccola e deliberatamente semplice, può essere un po 'confuso per iniziare. Il modo migliore per imparare è utilizzare un cheat sheet e scrivere il tuo documento di markdown. Puoi aggiornare il tuo readme.MD su GitHub e puoi ottenere molto supporto dalle funzioni integrate dei tuoi editori. Come nota a margine, GitHub supporta anche gli emoji che puoi aggiungere al tuo documento. Puoi usare il cheat sheet per trovare quali sono.
Scarica Markdown-Cheatshethere