Phenquestions
Un'introduzione a Markdown
Ribasso
Markdown è uno strumento di conversione da testo a HTML. Oggi è diventato di fatto il sinonimo di una classe di linguaggi di descrizione di markup leggeri. Usa una sintassi di formattazione del testo normale. L'idea alla base di Markdown era quella di rendere la scrittura di pagine web e soprattutto di post di blog facile come scrivere un'e-mail. Al momento di novembre 2017, l'obiettivo è raggiunto e Markdown così come le sue derivazioni Asciidoc, Asciidoctor e Asciidoctor-pdf sono ampiamente in uso.
Markdown si concentra solo sul testo normale e si astiene da tutte le altre complessità che si trovano in HTML. È facile da imparare in quanto è semplice, quindi anche più veloce in quanto vengono utilizzati caratteri minimi, il che porta anche a meno possibilità di errore alla fine. Vedere la figura 1 per un documento di base mostrato nell'editor Markdown Stackedit. Sul lato sinistro vedi il codice sorgente e sul lato destro il corrispondente output HTML. Potresti notare che i titoli sono semplicemente contrassegnati con un numero di # in base al livello di gerarchia del titolo.
Conversione del testo
Il testo semplice è convertibile in XHTML (HTML) e molti altri formati utilizzando gli strumenti della riga di comando come Markdown o Pandoc. Fondamentalmente, entrambi gli strumenti creano solo frammenti HTML e scrivono l'output su stdout. Pandoc offre l'opzione "-o nomefile" per scrivere l'output HTML nel file specificato. Come visto di seguito, il file di output è denominato basic.html e contiene il frammento HTML - due titoli e un paragrafo.
$ pandoc -o basic.html di base.md $ cat basic.htmlCreazione di pacchetti Debian HowTo
Prefazione
Essere responsabili di una macchina significa prendersi cura dell'hardware oltre che dei componenti software. Come si vede nella vita di tutti i giorni come amministratore di sistema, è molto meglio installare il software come pacchetto software piuttosto che come un mucchio di file sorgente. Ciò riduce i costi per mantenere correttamente il sistema. $
Per creare documenti HTML autonomi con un'intestazione HTML completa, Pandoc accetta l'opzione "-s" come segue:
$ pandoc -o basic.html -s di base.md $ cat basic.html
Creazione di pacchetti Debian HowTo
Prefazione
Essere responsabili di una macchina significa prendersi cura dell'hardware oltre che dei componenti software. Come si vede nella vita di tutti i giorni come amministratore di sistema, è molto meglio installare il software come pacchetto software piuttosto che come un mucchio di file sorgente. Ciò riduce i costi per mantenere correttamente il sistema.
Il vantaggio di mantenere il contenuto separato dal tuo display visivo è che non rovinerà l'aspetto del tuo sito. Versione 1.0.1, che è stato sviluppato da John Gruber e Aaron Swartz è stato rilasciato nel dicembre 2004 ed è disponibile come software gratuito (vedi link alla fine di questo articolo).
Elementi di testo
Titoli
In base al livello HTML corrispondente, i titoli sono scritti con un numero di # come segue:
# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6
Per H1 e H2 sono accettate due modalità di scrittura alternative:
H1 == H2 --
Si prega di notare che il numero di segni di uguale o trattini deve corrispondere al numero di caratteri del titolo.
Enfatizzare il testo
Per enfatizzare il testo sono supportati questi elementi:
- corsivo: asterischi singoli o underscore singoli
--
*importante* e _anche importante_
-- - testo in grassetto: doppi asterischi o doppi caratteri di sottolineatura
--
**importante** e __anche importante__
-- - testo barrato: doppia tilde
--
~~testo~~
--
Elenchi
Markdown supporta elenchi non ordinati e ordinati. Gli elenchi ordinati iniziano con un asterisco, un segno più o meno. Gli elenchi ordinati iniziano con una cifra. Per creare sottoliste, fai rientrare l'elemento della lista di due spazi (Markdown, StackEdit) o quattro spazi (Pandoc) come vedi di seguito:
1. frutta * mela * banana 2. bevande + acqua + latte
immagini
Il modo più semplice è utilizzare lo stile in linea come segue:
Questo visualizza l'immagine di riferimento. Non appena si sposta il puntatore del mouse sull'immagine viene visualizzato il testo di descrizione corrispondente.
Evidenziazione di codice e sintassi
Esistono due varianti: codice in linea e blocchi di codice. Il codice in linea è racchiuso in tre apici inversi come "'print ("Hello, world!”)“'. Anche i blocchi di codice iniziano e finiscono con tre apici inversi ma su righe separate come segue:
"stampa ("Ciao, mondo!")" Markdown non supporta l'evidenziazione della sintassi, ma dialetti come Markdown Here sì.
Tabelle
Markdown non supporta le tabelle ma estensioni come GFM e Markdown Here sì.
citazioni
Le virgolette iniziano con un segno ">". Diventa abbastanza utile citare il testo.
> "Oh! è assurdo avere una regola ferrea su cosa si dovrebbe > leggere e cosa non si dovrebbe. Più della metà della cultura moderna dipende > da ciò che non si dovrebbe leggere." > > L'importanza di essere sinceri. (Oscar Wilde)
Link
I link rimandano ad altri documenti oa sezioni di quello attuale. Lo stile di scrittura è simile alle immagini e consiste nella descrizione del collegamento tra parentesi quadre e l'URL tra parentesi normali.
[Sono un collegamento in linea](https://linuxhint.it)
Inoltre, puoi aggiungere un testo alternativo:
[Sono un collegamento in linea con testo aggiuntivo](https://linuxhint.com “LinuxHint”)
I link possono essere referenziati come segue:
[LinuxHint][1]... del testo... [1]: https://linuxhint.come
Ciò ti consente di creare facilmente elenchi di riferimenti alla fine del tuo documento come è comune nei documenti scientifici.
Conclusione
Markdown è piuttosto semplice e un must per tutti coloro che fanno documentazione e pubblicano regolarmente contenuti. È un grande piacere usarlo.
Riferimenti
- StackEdit, https://stackedit.io/editor
- Pandoc, http://padoc.org/
- Markdown, https://daringfireball.netto/progetti/ribasso/
- Cheatsheet di Markdown, https://github.com/adam-p/markdown-qui/wiki/Markdown-Cheatsheet
