Introduzione a Markdown

Introduzione a Markdown

Markdown

Markdown è uno strumento di conversione di testo a HTML. Oggi è diventato di fatto-sinonimo di una classe di lingue di descrizione markup leggera. Utilizza una sintassi di formattazione del testo semplice. L'idea alla base di Markdown era rendere le pagine Web di scrittura e in particolare le voci di blog facili come scrivere una e-mail. Al momento di novembre 2017, l'obiettivo è raggiunto e contrassegnato, nonché le sue derivazioni ASCIIDOC, ASCIIDOCTOR e ASCIIDOCTOR-PDF sono ampiamente in uso.

Markdown si concentra solo sul testo semplice e si astengono da tutte le altre complessità che si trovano in HTML. È facile da imparare in quanto è mantenuto semplice, quindi anche più veloce quando vengono utilizzati caratteri minimi, il che porta a meno possibilità di un errore alla fine anche. Vedere la Figura 1 per un documento di base mostrato nello stackedit di Markdown Editor. Sul lato sinistro si vede il codice sorgente e sul lato destro l'uscita HTML corrispondente. Potresti notare che i titoli sono semplicemente contrassegnati con un numero di #in base al livello della gerarchia del titolo.

Conversione del testo

Il testo semplice è convertibile in XHTML (HTML) e molti altri formati usando gli strumenti di riga di comando come Markdown o Pandoc. Fondamentalmente, entrambi gli strumenti creano solo frammenti HTML e scrivono l'output su stdout. Pandoc offre lo switch "-O nome file" per scrivere l'output HTML nel file dato. Come visto sotto il file di output è chiamato base.html e contiene il frammento HTML - due titoli e un paragrafo.

$ pandoc -o base.HTML BASIC.MD
$ Cat Basic.html

Creazione del pacchetto Debian Howto


Prefazione


Essere responsabili di una macchina significa prendersi cura dell'hardware e dei componenti del software. Come visto nella vita di tutti i giorni come amministratore di sistema, è molto meglio installare software come pacchetto software piuttosto che un mucchio di file di origine. Ciò riduce i costi per mantenere correttamente il sistema.
$

Per creare documenti HTML autonomi con un'intestazione HTML completa, Pandoc accetta l'interruttore "-s" come segue:

$ pandoc -o base.HTML -S BASIC.MD
$ Cat Basic.html










Creazione del pacchetto Debian Howto


Prefazione


Essere responsabili di una macchina significa prendersi cura dell'hardware e dei componenti del software. Come visto nella vita di tutti i giorni come amministratore di sistema, è molto meglio installare software come pacchetto software piuttosto che un mucchio di file di origine. Ciò riduce i costi per mantenere correttamente il sistema.

Il vantaggio di mantenere il contenuto separato dal tuo display visivo è che non incasinerà 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 collegamenti alla fine di questo articolo).

Elementi di testo

Titoli

Secondo il corrispondente livello HTML, i titoli sono scritti con un numero di #come segue:

# H1
## H2
### H3
#### H4
##### H5
###### H6

Per H1 e H2 sono accettati due modi di scrivere alternativi:

H1
==
H2
--

Si prega di notare che il numero di segni o trattini uguali deve abbinare il numero di caratteri del titolo.

Enfatizzare il testo

Al fine di enfatizzare il testo questi elementi sono supportati:

  • corsivo: singoli asterischi o singoli sottocorsi
    --
    * IMPORTANTE* e _A anche IMPORTANTE_
    --
  • Testo in grassetto: doppi asterischi o doppi sottoti
    --
    ** importante ** e __ anche importante__
    --
  • Testo incrociato: doppi tildes
    --
    ~~ 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 solo con una cifra. Per creare sublisti rientrano l'elenco 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 è usare lo stile in linea come segue:

![The Debian Logo] (Debian-Logo.PNG "Debian Logo")

Questo visualizza l'immagine di riferimento. Non appena si muovi il puntatore del mouse sull'immagine, vedi il testo di descrizione corrispondente.

Evidenziazione del codice e della sintassi

Esistono due varianti: codice in linea e blocchi di codice. Il codice inline è incorniciato in tre backtick come "" Stampa ("Hello, World!")" '. I blocchi di codice iniziano anche con tre backtick ma su righe separate come segue:

"
Stampa (“Ciao, mondo!")
"

Markdown non supporta l'evidenziazione della sintassi ma i dialetti come Markdown qui.

Tavoli

Markdown non supporta le tabelle ma estensioni come GFM e Markdown qui.

Blockquotes

Blockquotes iniziano con un segno ">". Diventa abbastanza utile citare il testo.

> "Oh! è assurdo avere una regola dura e veloce su ciò che si dovrebbe
> Leggi e cosa non si dovrebbe. Più della metà della cultura moderna dipende
> su ciò che non si dovrebbe leggere."
>
> L'importanza di essere serio. (Oscar Wilde)

Link

I collegamenti si riferiscono ad altri documenti o alle sezioni in quella attuale. Lo stile di scrittura è simile alle immagini e consiste nella descrizione del collegamento tra parentesi quadrate e l'URL tra parentesi regolari.

[Sono un link in linea in linea] (https: // linuxhint.com)

Inoltre, è possibile aggiungere un testo alternativo:

[Sono un link in stile in linea con testo aggiuntivo] (https: // linuxhint.com "Linuxhint")

I collegamenti possono essere citati come segue:

[Linuxhint] [1]
..
un po 'di testo
..
[1]: https: // linuxhint.com

Ciò consente di creare facilmente elenchi di riferimenti alla fine del documento in quanto è 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
  • Pandoc, http: // pandoc.org/
  • Markdown, https: // daringfireball.net/progetti/markdown/
  • Markdown Cheatsheet, https: // github.com/Adam-P/Markdown-Here/Wiki/Markdown-Cheat Sheet