Tutorial Markdown - Dall'installazione alla sintassi
Allo stesso tempo, il markdown è anche molto leggero e flessibile. Il caso d'uso più popolare per Markdown è per i file di licenza e readme in un repository GitHub, ma è anche integrato con sempre più CM per la gestione dei post sul blog e persino scrivere documenti di ricerca. Puoi rendere equazioni matematiche con plugin per lattice.
Tuttavia, è principalmente usato dagli sviluppatori. È davvero utile nel creare tutorial e documentazione grazie all'evidenziazione della sintassi per più lingue e supporto per immagini e persino GIF.
Cominciamo con una configurazione che ci consente di visualizzare in anteprima il documento rendering insieme a un file di testo di markdown grezzo.
Atom Text Editor e Markdown Anteprima
È possibile scaricare e installare Atom Text Editor o Visual Studio Code per seguire. Atom e VS Code hanno entrambi plugin preinstallati per l'anteprima di Markdown. Qui verrà utilizzato Atom ma la sintassi rimarrebbe all'incirca la stessa, indipendentemente dall'editor di testo che usi.
Su Atom, assicurarsi che il pacchetto di anteprima Markdown sia abilitato (in effetti, è abilitato per impostazione predefinita). Crea una cartella per questo tutorial di markdown e, lì, apri un nuovo file (Ctrl + N) e inserisci il seguente testo dentro.
# Questa è una voce___
## questa è anche una voce
Ecco un po 'di testo
Salva il file (CRTL + S) con a .Estensione MD. Ad esempio, puoi nominare il tuo file come test.md e il .La parte MD dirà a Atom che questo è un file di markdown e l'estensione funzionerebbe come previsto. È possibile generare un'anteprima utilizzando il seguente keybinding (ctrl+shift+m) che è mostrato in un nuovo riquadro accanto al file di testo grezzo.
È possibile chiudere il riquadro di anteprima utilizzando lo stesso legame chiave o usando la GUI stessa.
Con tutto impostato possiamo dare un'occhiata più da vicino alla sintassi e iniziare a creare documenti sorprendenti al volo.
Sintassi di markdown
Come accennato in precedenza, la principale motivazione dietro Markdown è la leggibilità. Questo significa nessun tag oscuro o tag nidificati o qualsiasi altra confusione che induce le stringhe. Invece possiamo iniziare con il simbolo '#' per indicare che quella particolare linea è un'intestazione.
# È un'intestazione.## indica anche l'intestazione, ma con una dimensione del carattere inferiore.
### puoi continuare a dimensioni consecutivamente più piccole
Interruzioni di riga
Markdown continua a raggruppare tutto il testo in un paragrafo gigante anche quando il testo grezzo viene suddiviso in diverse righe diverse. Per mitigare questo, puoi usare due spazi alla fine di una linea e quindi mettere un personaggio di Newline (cioè, colpito ) o semplicemente utilizzare due caratteri newline per un effetto leggermente diverso come mostrato di seguito.
La frase "ed è per questo che ..." è iniziata in una nuova linea ma non è distanziata dalla riga precedente, mentre l'uso di due nuove linee ha creato una separazione più ampia.
Regola orizzontale
La regola orizzontale, come suggerisce il nome, crea una linea orizzontale che ti consente di strutturare il documento e fare separazioni logiche in esso. Esistono due metodi per creare una regola orizzontale. Il primo è usare tre o più sottocorsi per creare una regola orizzontale.
#Heading 1___
Il paragrafo e l'intestazione sono separati da una regola orizzontale.
___
Un'altra sezione separata
Un'altra opzione (che non consiglierò) è quella di usare tre o più trattini '-' ma sono anche usate per indicare che la frase immediatamente sopra di loro è un'intestazione. Quindi, se non hai una nuova linea tra una frase e la regola orizzontale sotto di essa, quella frase assumerà la forma di una rotta.
Corsivo, audace e sciopero
La sintassi per i tre di questi è piuttosto semplice e parla da sola.
** Questo è in grassetto **__ Questo è anche audace__
_ Questo è corsivo_
*Questo è anche corsivo*
~~ questo è strikeThrough ~~
Carattere di fuga
Ora, si potrebbe chiedere, come scriveresti letteralmente ** un po 'di testo ** nel file di markdown finale se lo cambia in grassetto ogni volta. Questo è qualcosa che la maggior parte dei linguaggi di programmazione affronta anche e la soluzione è simile a quelle: usa un personaggio di backslash. Funziona anche per altri elementi di sintassi e non è specificamente per uno stile audace.
\ ** questo non è più audace \ **Se vuoi mostrare il personaggio di Backslash stesso, usa due e così via.
\\ si presenta come una singola barra
Blocchi e blocchi di codice
Blocchi e blocchi di codice sono molto più facili. Un blockquote può essere usato per evidenziare un punto importante verso il quale si desidera attirare l'attenzione dei lettori. Ciò può essere ottenuto usando la staffa angolare destra all'inizio come mostrato.
# Intestazione 1Lorem ipsum dolor sit amet, contipiscing élit, sed do eiusmod tempo temporario
Labrore et Dolore Magna aliqua. Ut enim ad minim veniam, quis nostrud esercitati ullamco laboris
nisi ut aliquip ex ea commodo conseguenza. DUI AUTE IRRE DOLOR in REPREDERIT IN VOLUPTATE
velit esse cillum dolore eu fugiat nulla pariatur. Excecetteur Sint Occacat Cupidatat Non
ProIDE, SUNT in Culpa Qui Officia Deserunt Mollet Anim Id Est Laborum.
> Questo è un riassunto ordinato di una sottosezione del tuo documento. Una coppia di linee che si trovano
fuori dal resto del contenuto.
Il contenuto continua.
Ecco come appare quando è reso.
Per i blocchi di codice, semplicemente rientrano le righe le righe per 4 spazi o più. Questo è davvero
utile per sviluppatori e operatori che vogliono documentare il loro lavoro. In seguito avremmo visto come renderlo ancora migliore.
Collegamenti ipertestuali e immagini
Per i collegamenti ipertestuali, la sintassi è piuttosto semplice. Il testo visibile è scritto tra parentesi quadrate e l'URL a cui punti è scritto tra parentesi rotonde proprio accanto ad esso.
Per le immagini, la sintassi è simile, tranne per il fatto che inizia con un marchio esclamativo. Sei libero di utilizzare un percorso relativo nella cartella del progetto che indica l'immagine o puoi avere un URL pubblico.
## illustrando il collegamento ipertestuale e la sintassi dell'immagine___
Dovresti [visitare noi] (https: // linuxhint.com) più spesso
Ecco come sono incorporate le immagini.
![Smugpug] (https: // caricamento.Wikimedia.org/wikipedia/commons/d/d2/bonny_bonita.Jpg)
Tavoli
La creazione di tabelle in markdown include letteralmente disegnare un ritratto ASCII (unicode) di una tabella.
## tabelle| Colonna 1 | Colonna 2 | Colonna 3 |
| --------- | --------- | --------- |
| Prima riga | Prima riga | Prima riga |
| Seconda riga | Seconda riga | Seconda riga |
La sintassi non deve essere esattamente allineata da una riga all'altra, ma il carattere del tubo viene utilizzato per passare alla colonna successiva e la riga successiva indica che la riga successiva è iniziata, generalmente.
Markdown esteso
Per quelli di voi che sono arrivati così lontano, ecco la vera sorpresa. Se si utilizza Atom, puoi effettivamente sostituire il plug -in di anteprima Markdown per Markdown Anteprima Plus. Che offre le seguenti funzionalità.
1. Equazioni matematiche che utilizzano lattice:
Puoi effettivamente inserire gli script in lattice tra i segni del dollaro e verranno resi come script di lattice e mostrato nell'anteprima con CTRL+SHIDFT+X KeyBinding. Non devi nemmeno sapere tutto il lattice, solo alcuni frammenti sono sufficienti.
## illustrando il lattice___
$$ | \ psi \ rangle = \ alpha | 0 \ rangle + \ beta | \ Rangle $$
2. Evidenziazione della sintassi
Invece di usare il rientro per indicare i blocchi di codice, è possibile utilizzare effettivamente backtick seguiti dal nome delle lingue in cui la tua sceneggiatura è presumibilmente scritta. Le lingue la cui sintassi è supportata sono troppo numerose per essere elencate qui, ma ecco un esempio in Python.
## Illustra l'evidenziazione della sintassi___
"pitone
importare questo
def my_function ():
Stampa ("Ciao, mondo!")
restituzione 0
"
Ci sono molti sapori o markdown. Github ha la sua birra speciale e la sintassi è molto flessibile. Questo non dovrebbe intimidire gli utenti, ma per soddisfare una più ampia varietà di essi. È una di quelle lingue che si comprende solo un sottoinsieme di cui uno ha bisogno e lo usa, invece di essere disturbato dai tecnicismi (a meno che tu non sia interessato ai suoi tecnicismi!)